Skip to main content

Create project boilerplate for any programming language in minutes, with just an idea.

Project description

Boilerplate-X - Create GitHub Project Boilerplate in Minutes!

Boilerplate-X is a chatGPT-powered solution to create GitHub project boilerplate for any programming language in just a few minutes. Have an idea? Turn it into a fully functional repository with Boilerplate-X!

DISCLAIMER! This project is highly experimental and is not ready for production use. Use at your own risk!

Why do I need this?

Starting a new project can be challenging, especially when it comes to writing basic, repetitive code. While there are many cookiecutter packages that help create an outline for your code, they aren't always tailored to your specific needs. Boilerplate-X, however, utilizes chatGPT to generate not only the foundational code like a cookiecutter but also actual code. This allows you to focus on developing unique features instead of spending hours setting up your repository.

boilerplate-x-logo

License: MIT PyPI version Hugging Face Spaces

🚀 Features

  • Powered by chatGPT and Langchain: Boilerplate-X uses OpenAI's chatGPT API and Langchain framework to generate your project template.
  • Create boilerplate for any programming language: Whether it's Python, JavaScript, Go, or any other language, Boilerplate-X has got you covered!
  • Easy to use: Create a template with a single CLI command.
  • Fast: Create boilerplate in minutes, not hours.
  • Customizable: Boilerplate-X allows you to customize your template with available options, such as adding unit tests, CI/CD, and more.
  • Open source: Boilerplate-X is open source and always will be. Contribute on GitHub!
  • GitHub integration: Boilerplate-X integrates with GitHub to create a new repository for your project.

Boilerplate-X has a collection of example boilerplates. You can find them in the examples folder.

📖 Table of Contents

💾 Installation

Boilerplate-X is available on PyPI and can be installed via pip.

pip install boilerplate-x

🎯 Quickstart

Creating a GitHub project boilerplate with Boilerplate-X is as simple as running the following CLI command:

boilerplate-x -p "your project idea" -o "path/to/project"

Now, you'll have a new folder at path/to/project containing your GitHub project template, which includes a .gitignore, LICENSE, README.md, and more!

For more CLI options, run boilerplate-x --help.

🤝 Contributing

Code check Publish

Contributions are more than welcome! If you have an idea for a new feature or want to help improve Boilerplate-X, please create an issue or submit a pull request on GitHub.

See CONTRIBUTING.md for more information.

⚖️ License

Boilerplate-X is released under the MIT License.

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

boilerplate_x-0.2.8.tar.gz (8.7 kB view details)

Uploaded Source

Built Distribution

boilerplate_x-0.2.8-py3-none-any.whl (9.6 kB view details)

Uploaded Python 3

File details

Details for the file boilerplate_x-0.2.8.tar.gz.

File metadata

  • Download URL: boilerplate_x-0.2.8.tar.gz
  • Upload date:
  • Size: 8.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.1 CPython/3.9.16 Linux/5.15.0-1034-azure

File hashes

Hashes for boilerplate_x-0.2.8.tar.gz
Algorithm Hash digest
SHA256 a7cb3ce147c5f4e1c7c3e01ad31daf8b2fb2fc7f2ba48810a3ed4a34293f7e1c
MD5 dcfb47e24be8e9e7efcfac381c4a8c31
BLAKE2b-256 1fb69557fa721947cd5db90d34bbef3dbdcfedc7741674a6a2830b7dc8bb5d9e

See more details on using hashes here.

File details

Details for the file boilerplate_x-0.2.8-py3-none-any.whl.

File metadata

  • Download URL: boilerplate_x-0.2.8-py3-none-any.whl
  • Upload date:
  • Size: 9.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.1 CPython/3.9.16 Linux/5.15.0-1034-azure

File hashes

Hashes for boilerplate_x-0.2.8-py3-none-any.whl
Algorithm Hash digest
SHA256 74c898550b06bc6b9ab5c1be414b8970084ff55819d85bd67d009f7cb1104d62
MD5 06b11db798e93d38dc0b1307bbe62995
BLAKE2b-256 286c1f5c6006a035ab0274c6134bd3ac82f89a7ddcfa30859c2fbcdd3dcac40f

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