Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mka142/python-template
template repository for python projects
https://github.com/mka142/python-template
Last synced: 24 days ago
JSON representation
template repository for python projects
- Host: GitHub
- URL: https://github.com/mka142/python-template
- Owner: mka142
- License: mit
- Created: 2023-09-13T14:32:31.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-09-13T14:43:18.000Z (over 1 year ago)
- Last Synced: 2023-09-14T04:56:14.023Z (over 1 year ago)
- Language: Dockerfile
- Size: 5.86 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# project title
# Development environment
You will need to install python at least version `3.10` amd `python3.10-venv`.
**Steps**:
1. Clone the repository
2. Create virtual environment
```bash
python3.10 -m venv venv
```
3. Activate virtual environment
```bash
source venv/bin/activate
```
4. Install dependencies and dev dependencies
```bash
pip install -r requirements.txt -r requirements-dev.txt
```
5. Now try to run tests:
```bash
cd YOUR_PROJECT_DIRECTORY/ && pytest
```
# Production environment
Our production environment is based on docker. If you want to run project service locally you will need to install `docker`.
After installing first build docker image:
```bash
./build.docker.sh
```
Then run docker container:
```bash
docker run --rm -it -p 8000:8000 YOUR_PROJECT_IMAGE:latest
```
# How to Contribute to the Project
If you want to contribute to the project, please read the [CONTRIBUTING.md](CONTRIBUTING.md) file.
# License
[MIT](LICENSE)