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.5.tar.gz (8.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

boilerplate_x-0.2.5-py3-none-any.whl (9.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: boilerplate_x-0.2.5.tar.gz
  • Upload date:
  • Size: 8.3 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.5.tar.gz
Algorithm Hash digest
SHA256 12ba7dba5bdfb17f63f440c08300bdbd348530cc159acc3e5aa743daa3ad14db
MD5 49ca38fd0842b4ba1c78809a4a61db97
BLAKE2b-256 3bcac7462f12659bc333b932603a2a2b97c10e8d2bb31461f5fd41b21cd8fe5b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: boilerplate_x-0.2.5-py3-none-any.whl
  • Upload date:
  • Size: 9.2 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 573c24f6dd1864e4ccb586576593219c466d4b58e3582b9068c968521e1229d2
MD5 073c78b5d7a40e10308af28c3bd6ceb5
BLAKE2b-256 6baf931fa8c876ae5859b2534fec27bd7b29af8b43a8b7dc11f8f5ff6932a3d2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page