Welcome to PyGenesis’s documentation!

PyGenesis

Python package repository template

Project on GitHub

• Mission

• Open Source Project

• Features

• Requirements

• Development Status

Mission

PyGenesis is a comprehensive Python package template designed to kickstart your projects instantly. With a clean and organized structure, it provides a hassle-free starting point for developers. Effortlessly begin your Python endeavors, focusing on your code, not the setup. Jumpstart your creativity with PyGenesis.

Open Source Project

This is the open source project with MIT license. Be free to use, fork, clone and contribute.

Features

• This README (Change it for your python project)

• This template base on libresource/open-source-checklist.

It contains may useful files for open source project: (CHECKLIST.md, CONTGIBUTING.md, CODE_OF_CONDUCT.md, and much more).

• setup.py for build your package

• requirements.txt and dev-requirements.txt

• Makefile with main commands to work with the project

• • run tests

• • calculate coverage

• • lint

• • build and install package

• • generate autodocumentation

• • others

• GitHub workflows

• • generate documentation

• • run tests with coverage

• • run linter

• • publish your package in PyPi

• • greetings for new contributors

Requirements

wheel

Development Status

• pygenesis

• 1.1.0

• 5 - Production/Stable

Project on PyPi

Contents:

• Install
  • Using pip
  • From release page
  • Clone from GitHub
• Quickstart
• Developer Documentation
  • Install requirement
  • Makefile
  • Get started
  • Build documentation
• FAQ
• pygenesis
  • pygenesis package

Indices and tables

• Index

• Module Index

• Search Page