Skip to content

Latest commit

 

History

History
131 lines (98 loc) · 5.01 KB

README.md

File metadata and controls

131 lines (98 loc) · 5.01 KB

Contributors Forks Stargazers

Python Logo

A template for developing production-ready Python applications.

Built With

Python Pytest Nix Codecov GitHub Actions

Preview

Video demonstration

Getting Started

Prerequisites

Before attempting to build this project, make sure you have direnv and Nix with Flake support installed on your machine.

Installation

To get a local copy of the project up and running on your machine, follow these simple steps:

  1. Clone the project repository

    git clone https://github.com/Kaweees/modern_python.git
cd modern_python

  2. Install the project dependencies

    If you have direnv installed, simply allow the environment:

    direnv allow

    Otherwise, you can use nix-shell to enter the environment:

    nix-shell --max-jobs $(nproc) # Linux / Windows (WSL)
nix-shell --max-jobs $(sysctl -n hw.ncpu) # macOS

  3. Run the project

    just run <package_name>

Project Structure

modern_python/
├── .github/                       - GitHub Actions CI/CD workflows
├── scripts/                       - Standalone scripts
├── shared/
│   └── utils/                     - Shared utility functions
├── src/                           - Project packages
│   ├── core/                      - Core application logic
│   └── ...                        - Other packages
├── tests/                         - Project tests (mirrors the main project structure)
├── LICENSE                        - Project license
└── README.md                      - You are here

License

The source code for Kaweees/modern_python is distributed under the terms of the GNU General Public License v3.0, as I firmly believe that collaborating on free and open-source software fosters innovations that mutually and equitably beneficial to both collaborators and users alike. See LICENSE for details and more information.