https://github.com/kc596/python-project-template
Template for a python project
https://github.com/kc596/python-project-template
Last synced: 9 months ago
JSON representation
Template for a python project
- Host: GitHub
- URL: https://github.com/kc596/python-project-template
- Owner: kc596
- Created: 2019-08-24T12:04:43.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2021-03-25T22:53:21.000Z (about 5 years ago)
- Last Synced: 2025-02-14T00:15:36.866Z (over 1 year ago)
- Language: Python
- Size: 2.93 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Template for python projects
### Running project
1. Install python3
2. Create virtual environment and activate it (recommended).
```
python3 -m venv venv
source venv/bin/activate
```
3. Install requirements. Goto root of the project and run the command.
```
python3 -m pip install -r requirements.txt
```
4. Set environment variables `PROJECT_ALIAS_PROFILE` and `PROJECT_ALIAS_CONFIG_PATH` as defined in `constants.py`
```
export PROJECT_ALIAS_PROFILE=prod
export PROJECT_ALIAS_CONFIG_PATH=config/
```
5. Start the project.
```
python3 -m src.main
```