v0.0.0

🛠 Ultralytics Python Project Template v0.0.0 Release Notes

Welcome to the inaugural release of the Ultralytics Python Project Template! This version sets the foundation for future development with a comprehensive and organized structure to facilitate Python project creation and management.

🎉 New Features

• Project Structure: A clean, intuitive layout for your project files, including directories for source code, tests, and documentation.
• Dependency Management: requirements.txt and Pipfile for easy package management.
• CI/CD Integration: Pre-configured GitHub Actions workflows for automated testing and deployment.
• Code Quality: Optional pre-commit hooks and linting configurations to maintain high standards of code quality.
• Documentation Support: An optional docs/ directory for comprehensive project documentation using Sphinx.
• Containerization: An optional Dockerfile for containerizing your project environment.
• Environment Management: An optional environment.yml for managing Conda dependencies.

🚀 Getting Started

1. Clone the Repository: Start by cloning the template repository.
2. Customize: Update files like requirements.txt, .pre-commit-config.yaml, and GitHub workflows to suit your project needs.
3. Develop: Add your source code in the src/ or your_package_name/ directory and corresponding tests in the tests/ directory.
4. Document: Update the README and add any necessary documentation in the docs/ directory.

🔧 Improvements and Fixes

This being the initial release, there are no previous versions to compare. However, we aim to continually improve the template based on feedback and evolving best practices.

📢 Contribute

We welcome contributions from the community! Check out our Contributing Guide for more information. We value your feedback and suggestions, so please don't hesitate to reach out.

📄 License

Choose between our AGPL-3.0 License for open-source collaboration or our Enterprise License for commercial use. For more details, visit our Licensing page.

Thank you for using the Ultralytics Python Project Template! We look forward to your feedback and contributions. Happy coding! 🚀

What's Changed

• Update README by @glenn-jocher in #1
• Toml by @glenn-jocher in #2
• Update to ultralytics/action in CI by @glenn-jocher in #3
• Update format.yml by @UltralyticsAssistant in #6
• Update format.yml by @glenn-jocher in #7
• Update format.yml by @glenn-jocher in #8
• Update pyproject.toml by @glenn-jocher in #9
• Update format.yml by @glenn-jocher in #10
• Update format.yml by @UltralyticsAssistant in #11
• Update pyproject.toml by @glenn-jocher in #12
• Update Actions with Lychee and GitHub Token by @pderrenger in #13
• Add file headers by @glenn-jocher in #14
• Update format.yml by @glenn-jocher in #15
• Update Ultralytics Actions with OpenAI GPT-4 PR Summary by @pderrenger in #16
• Update format.yml by @glenn-jocher in #17
• Fix issues link by @glenn-jocher in #18
• Update functions by @glenn-jocher in #19
• Add Ultralytics Discord badge by @glenn-jocher in #20
• Update .gitignore by @glenn-jocher in #21
• Update Ultralytics YouTube URL by @glenn-jocher in #22

New Contributors

• @glenn-jocher made their first contribution in #1
• @UltralyticsAssistant made their first contribution in #6
• @pderrenger made their first contribution in #13

Full Changelog: https://github.com/ultralytics/template/commits/v0.0.0