Python project boiler plate
This project aims to make the building, and deployment of python packages and docker containers using OneDev as simple as possible.
Features
- publish to DockerHub
- publish to pypi
- sync with GitHub
TODO
- add shields.io
- branch protection settings setup
How to Setup
- Make a new OneDev repository and copy the contents of this repository into it.
- Update the following values in setup.py:
- name
- note: this sets the name used on DockerHub, PyPI, and GitHub
- version
- description
- author
- license
- classifiers
- install requires
- extras_require
- name
- Update the docker file:
- add your contact info to the
MAINTAINERline CMDto whatever command starts your app
- add your contact info to the
- Create a Repository on GitHub with the same name as your OneDev project
- In OneDev:
- Edit step templates in the
.onedev-buildspec.yamlfile::- Execute tests:Run Pytest:
- add command to run test suite(s) if not pytest
- Publish Docker Container to Dockerhub: publish to dockerhub:
- update username to your dockerhub username
- Execute tests:Run Pytest:
- Under
Settings > Build > Job Secretsadd- your DockerHub password as
dockerhub_password - your DockerHub password as
dockerhub_user - your PyPI password as
pypi_password - your PyPI user as
pypi_user - your GitHub user as
github_user - your GitHub token as
github_token
- your DockerHub password as
- If there isn't already, make a 'Server Docker Executor' called
docker-executorunderAdministration > Job Executors
- Edit step templates in the
- fill in your
README.mdand remove this section
Contibuting
Contributions are welcome, this project is developed at dev.doze.dev where you can submit issues and open pull requests.
My Project
Describe what your package is about
Package Distribution
Installation
pip install my-project
Use
python ./src/main.py
Docker Distibution
Installation
docker pull docker_user/project_name:latest
Use
docker run -p 5000:5000 project_name
or for detached mode:
docker run -d -p 5000:5000 project_name
Metadata
Release files for onedev-python-project-boilerplate 0.1.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| onedev-python-project-boilerplate-0.1.2.tar.gz | 3.9 kB | Without provenance | Details for onedev-python-project-boilerplate-0.1.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| onedev_python_project_boilerplate-0.1.2-py3-none-any.whl | Python 3 | none | any | Details for onedev_python_project_boilerplate-0.1.2-py3-none-any.whl |
Total release size: 7.8 kB
Release files / onedev-python-project-boilerplate-0.1.2.tar.gz
| Download URL | onedev-python-project-boilerplate-0.1.2.tar.gz |
|---|---|
| Size | 3.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
bee110f376a4f7fc2707a17910f1826ab86fc1bb73b2052aa8f02f216922bdc8
|
|
BLAKE2b-256 checksum How to use checksums |
361497fbe0dc4ac444d36184ccf5de818fbbcd696a51e72a43cd377d49704fe8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.2
|
Release files / onedev_python_project_boilerplate-0.1.2-py3-none-any.whl
| Download URL | onedev_python_project_boilerplate-0.1.2-py3-none-any.whl |
|---|---|
| Size | 3.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
de36dcb709a1074d0b5bfa64d179791691ecb6ceaae44d1665e4dadd9db29584
|
|
BLAKE2b-256 checksum How to use checksums |
f86e6edf4a3eee184a36fcb96bfec38b240e820065d396a2850ac9db92332931
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.2
|
Security for onedev-python-project-boilerplate 0.1.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.