mramitdas/CookiePyStarter

CookiePyStarter is a Python boilerplate project generated by Cookiecutter. It provides a simple starting point for Python projects, including a predefined project structure, common development files, and a setup script.

CookiePyStarter

Crafting cutting-edge, Python boilerplate with a thoughtful design, essential components, and a seamless setup experience.

CookiePyStarter is a Python boilerplate project generated by Cookiecutter. It provides a simple starting point for Python projects, including a predefined project structure, common development files, and a setup script.

Powered by Cookiecutter

• Documentation: https://cookiecutter.readthedocs.io/en/stable/
• If you have problems with # CookiePyStarter, please open issues don't send emails to the maintainers.

Features

• Organized project structure
• Gitignore file for common Python projects
• Requirements directory for managing dependencies
• Starter code in the src directory
• Easy setup using the provided setup.sh script
• Code of Conduct, Contributing guidelines, and License files

Support This Project

If you find this project helpful and would like to support its development, consider the following:

• Sponsorship: Help fund the ongoing maintenance and development of this project by becoming a sponsor. Visit our GitHub Sponsors page.

• Contribute: Contribute to the project by submitting bug reports, feature requests, or pull requests. Check out our Contribution Guidelines for more details.

• Spread the Word: Share this project with others who might find it useful. Give it a star on GitHub to show your appreciation.

Your support goes a long way in ensuring the continued improvement of this project. Thank you!

Quick Start

1. Install Cookiecutter:

   pip install cookiecutter

2. Generate a new project using CookiePyStarter:

   cookiecutter https://github.com/mramitdas/CookiePyStarter.git

   Follow the prompts and customize the project information:

   • project_name: The name of your project (e.g., CookiePyStarter).
   • project_slug: Automatically generated based on the project_name.
   • description: A short description of the project.
   • author: Your name (or your organization/company/team).
   • github_username: Your GitHub username.
   • github_email: Your email address.
   • github_branch: The default branch for your GitHub repository (e.g., main).

3. Navigate to the generated project directory:

   cd YourProjectName  # Replace 'YourProjectName' with the name you provided during generation

4. Run the setup script:

   ./setup.sh

5. Start coding!

Project Structure

├── .github
│   ├── CODEOWNERS
│   ├── CODE_OF_CONDUCT.md
│   ├── CONTRIBUTING.md
│   ├── FUNDING.yml
│   ├── ISSUE_TEMPLATE
│   │   ├── bug_report.yml
│   │   ├── config.yml
│   │   └── feature-request.yml
│   ├── SECURITY.md
│   ├── SUPPORT.md
│   └── pull_request_template.md
├── .gitignore
├── LICENSE
├── README.md
├── src/
│ └── main.py
├── requirements
│   ├── base.txt
│   ├── dev.txt
│   └── prod.txt
└── setup.sh

• .github/: Directory containing GitHub-related files.
  • CODEOWNERS: Specifies code owners for the repository.
  • CODE_OF_CONDUCT.md: Code of Conduct for contributors.
  • CONTRIBUTING.md: Guidelines for contributing to the project.
  • FUNDING.yml: Configurations for GitHub Sponsors.
  • ISSUE_TEMPLATE/: Directory containing issue templates.
    • bug_report.yml: Template for bug reports.
    • config.yml: Configuration file for issue templates.
    • feature-request.yml: Template for feature requests.
  • SECURITY.md: Security-related information.
  • SUPPORT.md: Support information for the project.
  • pull_request_template.md: Template for pull requests.
• .gitignore: Gitignore file for common Python projects.
• LICENSE: Project license.
• README.md: Project's main documentation.
• src/: Directory for your project's source code.
  • main.py: Starter code file.
• requirements/: Directory for managing project dependencies.
  • base.txt: Base dependencies.
  • dev.txt: Development dependencies.
  • prod.txt: Production dependencies.
• setup.sh: Setup script for initializing the project.

Community

• Have questions? Before you ask questions anywhere else, please post your question on Stack Overflow under the cookiepystarter tag. We check there periodically for questions.

• If you think you found a bug or want to request a feature, please open an issue.

• For anything else, you can chat with us on Telegram.

  

Not Exactly What You Want?

This is what I want. It might not be what you want. Don't worry, you have options:

Fork This

If you have differences in your preferred setup, I encourage you to fork this to create your own version. Once you have your fork working, let me know and I'll add it to a 'Similar Cookiecutter Templates' list here. It's up to you whether to rename your fork.

If you do rename your fork, I encourage you to submit it to the following places:

• cookiecutter so it gets listed in the README as a template.

Submit a Pull Request

We accept pull requests if they're small, atomic, and make our own project development experience better.

Contributing

If you'd like to contribute to this project, please read the Contributing Guidelines and follow the Code of Conduct.

License

This project is licensed under the GPL-3.0 License.

Contact

For questions or feedback, feel free to reach out to mramitdas99@gmail.com.