pygenesis-django

Python Django package repository template

You can find Full Project Documentation here

Workflows

Package

Support

Downloads

Languages

Development

Menu

• Mission
• Open Source Project
• Features
• Requirements
• Development Status
• Install
• Quickstart
• Contributing

Mission

pygenesis-django is a comprehensive Python Django 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-django.

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/pygenesis. It contains may useful files for open source project: (CHECKLIST.md, CONTRIBUTING.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

Requirements

• django, pylint, yamllint, sphinx, sphinx_rtd_theme
• See more in Full Documentation

Development Status

• Package already available on PyPi
• See more in Full Documentation

Install

with pip

pip install pygenesis-django

See more in Full Documentation

Quickstart

Add package to INSTALLED_APPS

INSTALLED_APPS = [
    ...,
    'pygenesis_django',
]

Run tests

python manage.py test

Run info command

python manage.py pygenesis_django_info

More examples in Full Documentation

Contributing

You are welcome! To easy start please check:

• Full Documentation
• Contributing
• Developer Documentation
• Code of Conduct
• Security Policy
• Governance
• Support