https://github.com/pythoninthegrass/silver-happiness
kamal mvp. Took github up on their offer for inspiration
https://github.com/pythoninthegrass/silver-happiness
Last synced: 11 months ago
JSON representation
kamal mvp. Took github up on their offer for inspiration
- Host: GitHub
- URL: https://github.com/pythoninthegrass/silver-happiness
- Owner: pythoninthegrass
- License: unlicense
- Created: 2023-11-10T19:52:00.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-03T16:08:31.000Z (almost 2 years ago)
- Last Synced: 2025-01-11T16:50:22.790Z (about 1 year ago)
- Language: Python
- Homepage:
- Size: 2.51 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# mvp
**minimum viable python**
## Summary
Sets up a new development environment for a Mac or Linux (i.e., UNIX) box.
**Table of Contents**
* [mvp](#mvp)
* [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
```
## Development
```bash
# install tools and runtimes (cf. xcode, brew, asdf, poetry, etc.)
./bootstrap # dev only runs plays w/tags and is verbose
# install git hooks
./bootstrap install-precommit
# update git hooks
./bootstrap update-precommit
```
## TODO
* [Open Issues](https://github.com/pythoninthegrass/mvp/issues)
* QA [Ansible playbook](ansible/playbook.yml)
* Test
* macOS
* Ubuntu
* 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/)