Skip to content

Commit 17e5034

Browse files
Update README.md
Organize TODO section to help with hacktoberfest visitors and link to CONTRIBUTING.md
1 parent a457c8b commit 17e5034

File tree

1 file changed

+28
-17
lines changed

1 file changed

+28
-17
lines changed

README.md

Lines changed: 28 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@
66
## Summary
77
Oftentimes the initial setup of a Python repo can take a few minutes to a couple hours.
88
By laying the foundation to rapidly implement an idea, can focus on the good bits instead of
9-
devops drudgery.
9+
DevOps drudgery.
1010

1111
### Caveat Emptor
1212
Very little of this gets tested on Windows hosts. Windows Subsystem for Linux (WSL) is used where necessary with the default Ubuntu LTS install. Moved bulk of document to the [markdown](markdown/) directory to opt-in vs. opt-out of documentation.
1313

14-
Be the change et al if Windows is your main and you wanna raise a PR with broad instructions on getting tooling working under Windows (e.g., docker, poetry, playwright.)
14+
Be the change et al if Windows is your main and you wanna [raise a PR](CONTRIBUTING.md) with broad instructions on getting tooling working under Windows (e.g., docker, poetry, playwright.)
1515

1616
**Table of Contents**
1717
* [python_template](#python_template)
@@ -37,21 +37,32 @@ Be the change et al if Windows is your main and you wanna raise a PR with broad
3737
Development environments and tooling are first-class citizens on macOS and *nix. For Windows faithfuls, please setup [WSL](markdown/wsl.md).
3838

3939
## TODO
40-
* Django
41-
* Merge with [docker_python](https://github.com/pythoninthegrass/docker_python) and put the latter on an ice float
42-
* Flask
43-
* Bonus points for [Svelte](https://svelte.dev/blog/the-easiest-way-to-get-started) front-end ❤️
44-
* FastAPI
45-
* MongoDB
46-
* Switch to `docker-compose`
47-
* Fix unique index deleting too many keys
48-
* k8s
49-
* `~/.kubeconfig`
50-
* ansible
51-
* wsl
52-
* VSCode
53-
* Remote WSL install and usage
54-
* Or at least further reading nods
40+
* [Open Issues](https://github.com/pythoninthegrass/python_template/issues)
41+
* Webdev
42+
* Django
43+
* Merge with [docker_python](https://github.com/pythoninthegrass/docker_python) and put the latter on an ice float
44+
* [Django Ninja](https://realpython.com/courses/rest-apis-with-django-ninja/)
45+
* Flask
46+
* Bonus points for [Svelte](https://svelte.dev/blog/the-easiest-way-to-get-started) front-end ❤️
47+
* FastAPI
48+
* NoSQL
49+
* MongoDB
50+
* Switch to `docker-compose`
51+
* Fix unique index deleting too many keys
52+
* [Redis](https://realpython.com/python-redis/)
53+
* DevOps
54+
* k8s
55+
* `~/.kubeconfig`
56+
* [Argo](https://argoproj.github.io/)
57+
* [Flux](https://fluxcd.io/)
58+
* [DevSpace](https://www.devspace.sh/)
59+
* [Ansible](https://realpython.com/automating-django-deployments-with-fabric-and-ansible/)
60+
* [Heroku](https://realpython.com/courses/deploying-a-flask-application-using-heroku/)
61+
* [justfile](https://just.systems/man/en/)
62+
* [Windows Subsystem for Linux (WSL)](markdown/wsl.md)
63+
* VSCode
64+
* Remote WSL install and usage
65+
* Or at least further reading nods
5566
* Debugging
5667
* Dependencies
5768
* script itself via [icecream](https://github.com/gruns/icecream)

0 commit comments

Comments
 (0)