Skip to main content

Epigraphhub Python package

Project description


Build status Python Version

Code style: black Security: bandit Pre-commit Semantic Versions License Coverage Report

Epigraphhub Python package

Very first steps

Initialize your code

  1. Initialize git inside your repo:
cd epigraphhub && git init
  1. If you don't have Poetry installed run:
make poetry-download
  1. Initialize poetry and install pre-commit hooks:
make install
make pre-commit-install
  1. Run the codestyle:
make codestyle
  1. Upload initial code to GitHub:
git add .
git commit -m ":tada: Initial commit"
git branch -M main
git remote add origin
git push -u origin main

Set up bots

  • Set up Stale bot for automatic issue closing.


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


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 as major, minor, or patch. 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.


🚀 Features

Development features

Deployment features

Open source community features


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

  author = {thegraphnetwork},
  title = {Epigraphhub Python package},
  year = {2021},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{}}

Credits 🚀 Your next Python package needs a bleeding-edge project structure.

This project was generated with python-package-template

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

epigraphhub-1.1.1.tar.gz (45.9 kB view hashes)

Uploaded Source

Built Distribution

epigraphhub-1.1.1-py3-none-any.whl (49.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page