https://github.com/multani/template-python
https://github.com/multani/template-python
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/multani/template-python
- Owner: multani
- Created: 2022-09-08T16:59:48.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-10T22:35:22.000Z (about 1 year ago)
- Last Synced: 2025-04-14T21:58:41.088Z (about 1 year ago)
- Language: Dockerfile
- Size: 295 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# A template for Python project
## How to use?
1. Pick a project name: it should be a [valid Python module
name](https://legacy.python.org/dev/peps/pep-0008/#package-and-module-names):
> Modules should have short, all-lowercase names. Underscores can be used in the
> module name if it improves readability. Python packages should also have
> short, all-lowercase names, although the use of underscores is discouraged.
Let's call it here: `$MY_PROJECT`.
1. Clone this repository
1. Rename the `NAME` folder to the name of your project:
```bash
mv NAME $MY_PROJECT
```
1. Run:
```bash
grep NAME -w -r . -l | xargs sed -i "s/\/$MY_PROJECT/g"
```
1. Commit everything and start working!