Epigraphhub Python package
Project description
epigraphhub_py
Very first steps
Initialize your code
- Initialize
git
inside your repo:
cd epigraphhub && git init
- If you don't have
Poetry
installed run:
make poetry-download
- Initialize poetry and install
pre-commit
hooks:
make install
make pre-commit-install
- Run the codestyle:
make codestyle
- Upload initial code to GitHub:
git add .
git commit -m ":tada: Initial commit"
git branch -M main
git remote add origin https://github.com/thegraphnetwork/epigraphhub_py.git
git push -u origin main
Set up bots
- Set up Stale bot for automatic issue closing.
Poetry
Want to know more about Poetry? Check its documentation.
Details about Poetry
Poetry's commands are very intuitive and easy to learn, like:
poetry add numpy@latest
poetry run pytest
poetry publish --build
etc
Building and releasing your package
Building a new version of the application contains steps:
- Bump the version of your package
poetry version <version>
. You can pass the new version explicitly, or a rule such asmajor
,minor
, orpatch
. For more details, refer to the Semantic Versions standard. - Make a commit to
GitHub
. - Create a
GitHub release
. - And... publish 🙂
poetry publish --build
🎯 What's next
Well, that's up to you 💪🏻. I can only recommend the packages and articles that helped me.
Typer
is great for creating CLI applications.Rich
makes it easy to add beautiful formatting in the terminal.Pydantic
– data validation and settings management using Python type hinting.Loguru
makes logging (stupidly) simple.tqdm
– fast, extensible progress bar for Python and CLI.IceCream
is a little library for sweet and creamy debugging.orjson
– ultra fast JSON parsing library.Returns
makes you function's output meaningful, typed, and safe!Hydra
is a framework for elegantly configuring complex applications.FastAPI
is a type-driven asynchronous web framework.
Articles:
- Open Source Guides.
- A handy guide to financial support for open source
- GitHub Actions Documentation.
- Maybe you would like to add gitmoji to commit names. This is really funny. 😄
🚀 Features
Development features
- Supports for
Python 3.9
and higher. Poetry
as the dependencies manager. See configuration inpyproject.toml
andsetup.cfg
.- Automatic codestyle with
black
,isort
andpyupgrade
. - Ready-to-use
pre-commit
hooks with code-formatting. - Type checks with
mypy
; docstring checks withdarglint
; security checks withsafety
andbandit
- Testing with
pytest
. - Ready-to-use
.editorconfig
,.dockerignore
, and.gitignore
. You don't have to worry about those things.
Deployment features
GitHub
integration: issue and pr templates.Github Actions
with predefined build workflow as the default CI/CD.- Everything is already set up for security checks, codestyle checks, code formatting, testing, linting, docker builds, etc with
Makefile
. More details in makefile-usage. - Dockerfile for your package.
- Automatic drafts of new releases with
Release Drafter
. You may see the list of labels inrelease-drafter.yml
. Works perfectly with Semantic Versions specification.
Open source community features
- Ready-to-use Pull Requests templates and several Issue templates.
- Files such as:
LICENSE
,CONTRIBUTING.md
,CODE_OF_CONDUCT.md
, andSECURITY.md
are generated automatically. Stale bot
that closes abandoned issues after a period of inactivity. (You will only need to setup free plan). Configuration is here.- Semantic Versions specification with
Release Drafter
.
Installation
pip install -U epigraphhub
or install with Poetry
poetry add epigraphhub
Then you can run
epigraphhub --help
or with Poetry
:
poetry run epigraphhub --help
Makefile usage
Makefile
contains a lot of functions for faster development.
Configuration file
epigraphhub_py
needs a configuration file in order to access the database.
After you have the library installed, you can run the following command (just an example):
epigraphhub-config \
--db-host localhost \
--db-port 25432 \
--db-credential "public:dev_epigraphhub/dev_epigraph/dev_epigraph"
We need to have connection for all these 3 databases:
- public,
- private
- sandbox
📈 Releases
You can see the list of available releases on the GitHub Releases page.
We follow Semantic Versions specification.
We use Release Drafter
. As pull requests are merged, a draft release is kept up-to-date listing the changes, ready to publish when you’re ready. With the categories option, you can categorize pull requests in release notes using labels.
List of labels and corresponding titles
Label | Title in Releases |
---|---|
enhancement , feature |
🚀 Features |
bug , refactoring , bugfix , fix |
🔧 Fixes & Refactoring |
build , ci , testing |
📦 Build System & CI/CD |
breaking |
💥 Breaking Changes |
documentation |
📝 Documentation |
dependencies |
⬆️ Dependencies updates |
You can update it in release-drafter.yml
.
GitHub creates the bug
, enhancement
, and documentation
labels for you. Create the remaining labels on the Issues tab of your GitHub repository, when you need them.
🛡 License
This project is licensed under the terms of the GNU GPL v3.0
license. See LICENSE for more details.
📃 Citation
@misc{epigraphhub_py,
author = {thegraphnetwork},
title = {Epigraphhub Python package},
year = {2021},
publisher = {GitHub},
journal = {GitHub repository},
howpublished = {\url{https://github.com/thegraphnetwork/epigraphhub_py}}
}
Credits
This project was generated with python-package-template
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
Hashes for epigraphhub-1.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6e107225a05989a5987ab5b8c3c783ee96aef062a39f34e7f4e68159dc5ef3bb |
|
MD5 | 72426a273c512fa624b27dabca578990 |
|
BLAKE2b-256 | 5b69bc0cfdec6e3086c2453455eb4351f3ba6a7be8883b06bbf7cc2214113154 |