Skip to main content

Python Starters

PyPI Status Python Version License

Read the documentation at https://python-starters.readthedocs.io/ Tests Codecov

pre-commit Black

🚀 Python Starters Documentation

Welcome to the Python Starters documentation! Python Starters is a tool designed to streamline the process of initializing, managing, and updating project starters based on cookiecutter templates. This tool simplifies Git operations, specifically working with subtrees and submodules, and provides a user-friendly interface for project scaffolding.

📦 Installation

To install Python Starters via pip from PyPI, run the following command:

pip install python-starters

This will install Python Starters

Ensure you have Git installed on your system, as Python Starters relies on Git for version control of starters.

🛠️ Quick Start

To quickly start using Python Starters, follow these steps:

  1. Initialize your project:
python-starters init
  1. Add a starter to your project:
python-starters add <starter_git_url>
  1. Customize your starter as needed and enjoy streamlined project setup!

🌟 Basic Usage

Python Starters simplifies the process of working with project starters. Below are the basic commands:

  • Initializing Python Starters:

    python-starters init
    
  • Adding a Starter:

    python-starters add <starter_git_url>
    
  • Updating a Starter:

    python-starters update <starter_name>
    
  • Removing a Starter:

    python-starters remove <starter_name>
    

⚙️ Advanced Usage

For advanced usage of Python Starters, consider the following commands:

  • Resolving Merge Conflicts:

    python-starters resolve <starter_name>
    
  • Listing All Starters:

    python-starters list
    
  • Customizing Starters:

    Customize your starter by editing the generated configuration files. Python Starters will respect these customizations during updates.

Please see the Command-line Reference for details.

📘 API Reference

Python Starters also provides an API for programmatic access to its functionalities. Below is the reference for the API:

  • initialize_project(): Initializes Python Starters in the current project.

  • add_new_starter(starter_git_url: str): Adds a new starter to the project from the given Git URL.

  • update_existing_starter(starter_name: str): Updates the specified starter to its latest version.

  • remove_starter(starter_name: str): Removes the specified starter from the project.

  • resolve_starter_conflicts(starter_name: str): Assists in resolving merge conflicts for the specified starter.

  • list_all_starters(): Lists all starters added to the current project.

Each function is designed to be intuitive and easy to use, mirroring the simplicity of the CLI commands.

Requirements

  • Python >=3.11

Contributing

Contributions are very welcome. To learn more, see the Contributor Guide.

License

Distributed under the terms of the MIT license, Python Starters is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Credits

This project was generated from @cjolowicz's Hypermodern Python Cookiecutter template.

Metadata

Release files for python-starters 0.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for python-starters 0.0.2
File Size Uploaded Provenance Actions
python_starters-0.0.2.tar.gz 4.8 kB Without provenance Details for python_starters-0.0.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for python-starters 0.0.2
File Interpreter ABI Platform Actions
python_starters-0.0.2-py3-none-any.whl Python 3 none any Details for python_starters-0.0.2-py3-none-any.whl

Total release size: 10.7 kB

Release files / python_starters-0.0.2.tar.gz

Download URL python_starters-0.0.2.tar.gz
Size 4.8 kB
Tags Source
SHA-256 checksum
How to use checksums
3e6e588b9e05d0cf77c8fce82bd9d476d9068c8a8ff106fe8b6f69026d6144af
BLAKE2b-256 checksum
How to use checksums
b4622523c767c27d4db0f8600f3612bffbbefa01618c3c4dc6d688e9a6c61059
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.6

Release files / python_starters-0.0.2-py3-none-any.whl

Download URL python_starters-0.0.2-py3-none-any.whl
Size 5.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9b1b1313fb1c0c46e06a411329b03b36fdb188145228d02054cf1b183c6b89ef
BLAKE2b-256 checksum
How to use checksums
a2712acc802ca854e50a84894a90bd232cc4c163ed351b1ddb395e29616bdd39
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.6

Security for python-starters 0.0.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.0.2 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page