https://github.com/pythoninthegrass/its_my_party
And I'll cry if I want to
https://github.com/pythoninthegrass/its_my_party
docker python
Last synced: 20 days ago
JSON representation
And I'll cry if I want to
- Host: GitHub
- URL: https://github.com/pythoninthegrass/its_my_party
- Owner: pythoninthegrass
- License: unlicense
- Created: 2023-12-28T03:07:53.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-23T16:01:48.000Z (almost 2 years ago)
- Last Synced: 2025-01-11T16:50:29.275Z (about 1 year ago)
- Topics: docker, python
- Language: Shell
- Homepage:
- Size: 1.05 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# its_my_party
## Summary
Sets up a new development environment for a Mac or Linux (i.e., UNIX) box.
**Table of Contents**
* [its\_my\_party](#its_my_party)
* [Summary](#summary)
* [Setup](#setup)
* [Quickstart](#quickstart)
* [Development](#development)
* [TODO](#todo)
* [Further Reading](#further-reading)
## Setup
* Minimum requirements
* [Python 3.11](https://www.python.org/downloads/)
* Dev dependencies
* make
* [Linux](https://www.gnu.org/software/make/)
* [macOS](https://www.freecodecamp.org/news/install-xcode-command-line-tools/)
* [editorconfig](https://editorconfig.org/)
* [wsl](https://docs.microsoft.com/en-us/windows/wsl/setup/environment)
## Quickstart
* Install python and tooling
```bash
# install python and dependencies (e.g., git, ansible, etc.)
./bootstrap install
```
* Run server
```bash
# script
./bootstrap run
# manual
gunicorn -w 4 -k uvicorn.workers.UvicornWorker -b 0.0.0.0:8000 app:app --reload
```
## Development
* `asdf`
```bash
asdf install
```
* `poetry`
```bash
# install dependencies
poetry install
# shell
poetry shell
# run
poetry run python app.py
# deactivate
exit
```
* `./boostrap` commands
```bash
# update pyproject.toml and poetry.lock
./bootstrap bump-deps
# export requirements.txt
./bootstrap export-reqs
# install git hooks
./bootstrap install-precommit
# update git hooks
./bootstrap update-precommit
```
* [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/)
```bash
# install commitizen
npm install -g commitizen
commitizen init cz-conventional-changelog --save-dev --save-exact
# commit
git add .
# commitizen
git cz
```
## TODO
* [Open Issues](https://github.com/pythoninthegrass/its_my_party/issues)
* Write boilerplate pytest tests
* CI/CD
## Further Reading
* [python](https://www.python.org/)
* [asdf](https://asdf-vm.com/guide/getting-started.html#_2-download-asdf)
* [poetry](https://python-poetry.org/docs/)
* [docker-compose](https://docs.docker.com/compose/install/)
* [pre-commit hooks](https://pre-commit.com/)