Skip to main content

No project description provided

Project description

Monorepo Factory

Monorepo Factory is a command-line tool designed to streamline the process of setting up repositories and submodules based on a TOML configuration file. It automates the creation of monorepos, allowing you to define complex repository structures in a simple and declarative manner.

Features

  • Automated Repository Creation: Generate multiple repositories with predefined settings.
  • Submodule Support: Easily configure and include submodules within your repositories.
  • Pattern Matching: Apply patterns to match and configure repositories dynamically.
  • Customizable Initialization: Initialize repositories with custom READMEs and other initial files.

Installation

Monorepo Factory can be installed using pipx, which allows you to run Python applications in isolated environments. To install pipx and Monorepo Factory, follow these steps:

# Install pipx if it's not already installed
python3 -m pip install --user pipx
python3 -m pipx ensurepath
# Install Monorepo Factory using pipx
pipx install monorepo-factory

Usage

To use Monorepo Factory, you need to have a TOML configuration file that defines the structure of your repositories and any patterns or submodules you want to include.

# Run Monorepo Factory with the path to your TOML configuration file
monorepo_factory PATH_TO_TOML_FILE

For detailed usage instructions, you can use the --help flag:

$ poetry run python monorepo_factory --help

 Usage: monorepo_factory [OPTIONS] TOML_FILE

 Main function to set up repositories and submodules from a TOML configuration file.

╭─ Arguments ────────────────────────────────────────────╮
│ *    toml_file      TEXT  [default: None] [required]   │
╰────────────────────────────────────────────────────────╯
╭─ Options ──────────────────────────────────────────────╮
│ --help          Show this message and exit.            │
╰────────────────────────────────────────────────────────╯

Configuration

Your TOML configuration file should define the repositories, submodules, and any patterns that you want to apply. Here's an example structure of what the TOML file might look like:

# Define repositories and their properties
[[repo]]
name = "main-repo"
description = "This is the main repository."
# Define submodules for a repository
[[repo.subrepos]]
name = "submodule-1"
path = "libs/submodule-1"
# Define patterns to apply settings to repositories matching a pattern
[[pattern]]
pattern = "service-"
description = "Services repository pattern."

Contributing

Contributions to Monorepo Factory are welcome! Please read the CONTRIBUTING.md file for guidelines on how to contribute to this project.

License

Monorepo Factory is released under the MIT License. See the LICENSE file for more information.

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

monorepo_factory-1.0.1.tar.gz (4.5 kB view details)

Uploaded Source

Built Distribution

monorepo_factory-1.0.1-py3-none-any.whl (5.1 kB view details)

Uploaded Python 3

File details

Details for the file monorepo_factory-1.0.1.tar.gz.

File metadata

  • Download URL: monorepo_factory-1.0.1.tar.gz
  • Upload date:
  • Size: 4.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for monorepo_factory-1.0.1.tar.gz
Algorithm Hash digest
SHA256 ef8c50865a1c82f4dc972c2d7b3fc80a38a2f7387452ba7d894b29cc61b67e41
MD5 26ac3dcb5de8dc3e4412dca383d29bb5
BLAKE2b-256 8c91bb92b9d28e0b531a5675aa46dc108c1220537bb85c0bf0ebf2abea720635

See more details on using hashes here.

File details

Details for the file monorepo_factory-1.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for monorepo_factory-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9d278a0f813b337c3b14cfc64c12b25552b5d7ec611c723166763bf2e8af3e43
MD5 d0df45105aeb11b0d82160246cc3dae7
BLAKE2b-256 be0c85f6974ac1b4b732ddd13f27b71368d2b29d2b163bfb409e14269b18cb17

See more details on using hashes here.

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