A short description of your project
Project description
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
MAINTAINER
line CMD
to 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.yaml
file::- 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 Secrets
add- 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-executor
underAdministration > Job Executors
- Edit step templates in the
- fill in your
README.md
and 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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for onedev-python-project-boilerplate-0.1.2.dev90.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7883e3f98a77e2c98e873021986ec7317fe97f0272e450fc49b7119ed2c0f468 |
|
MD5 | 60216fd3e6faea606bfee8cb0490ddbb |
|
BLAKE2b-256 | 64f22973faa55968972092ba277bbd3d2ca38213c85b6a021287614107df311e |
Close
Hashes for onedev_python_project_boilerplate-0.1.2.dev90-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d361a7b440e266af34cf7ad470076714adb57902a3dbe2bf4d88ea49339689e4 |
|
MD5 | 1dace63896f5b78a5f462dd509dddbfd |
|
BLAKE2b-256 | e2345b24a51f9b7965600b57c5b9ace4a3994c0b79720e45963aafb5b459df4f |