# Ultralytics pip Package Template
This is a minimal template repository for reserving Python package names on PyPI and deploying v0.0.0 placeholders. It provides a streamlined way to ensure that your package name is available for future development and releases.
## What is this repository for?
- **Name Reservation**: Ensures the package name you desire is reserved on PyPI.
- **Placeholder Deployment**: Allows for an initial v0.0.0 release to indicate the package name is taken but the package is not yet functional.
## Quick Start
### Step 1: Clone the Repository
Clone this repository to your local machine.
```bash
git clone https://github.com/ultralytics/pip.git <your-package-name>
```
### Step 2: Update Package Information
Edit the `setup.py` file to update the package name, author, and other meta-information.
### Step 3: Create a Virtual Environment (Optional)
It's a good practice to create a virtual environment.
```bash
python3 -m venv venv
source venv/bin/activate # On Windows, use `venv\Scripts\activate`
```
### Step 4: Install Dependencies
If your package has dependencies, install them.
```bash
pip install -r requirements.txt
```
### Step 5: Package and Upload
Package your code and upload it to PyPI.
```bash
python setup.py sdist bdist_wheel
twine upload dist/*
```
Now your package name is reserved and a v0.0.0 placeholder is deployed on PyPI.
## Recommendations
- Once you start the actual development, replace this README with one that describes your package's functionality.
- Add a `LICENSE` file appropriate for your project.
- Update the `requirements.txt` and `setup.py` as your project evolves.
## Support
For issues and feature requests related to this template, please open an issue on GitHub.
## License
This project is licensed under the AGPL-3.0 License. For more details, see the [LICENSE](LICENSE) file.
Raw data
{
"_id": null,
"home_page": "https://github.com/ultralytics/pip",
"name": "ultralytics-hub-sdk",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Ultralytics",
"author_email": "hello@ultralytics.com",
"download_url": "https://files.pythonhosted.org/packages/cb/a9/f45c688ba8cf26309de42c63344028b979a679275754a2815bd25394a2b3/ultralytics-hub-sdk-0.0.0.tar.gz",
"platform": null,
"description": "# Ultralytics pip Package Template\n\nThis is a minimal template repository for reserving Python package names on PyPI and deploying v0.0.0 placeholders. It provides a streamlined way to ensure that your package name is available for future development and releases.\n\n## What is this repository for?\n\n- **Name Reservation**: Ensures the package name you desire is reserved on PyPI.\n- **Placeholder Deployment**: Allows for an initial v0.0.0 release to indicate the package name is taken but the package is not yet functional.\n\n## Quick Start\n\n### Step 1: Clone the Repository\n\nClone this repository to your local machine.\n\n```bash\ngit clone https://github.com/ultralytics/pip.git <your-package-name>\n```\n\n### Step 2: Update Package Information\n\nEdit the `setup.py` file to update the package name, author, and other meta-information.\n\n### Step 3: Create a Virtual Environment (Optional)\n\nIt's a good practice to create a virtual environment.\n\n```bash\npython3 -m venv venv\nsource venv/bin/activate # On Windows, use `venv\\Scripts\\activate`\n```\n\n### Step 4: Install Dependencies\n\nIf your package has dependencies, install them.\n\n```bash\npip install -r requirements.txt\n```\n\n### Step 5: Package and Upload\n\nPackage your code and upload it to PyPI.\n\n```bash\npython setup.py sdist bdist_wheel\ntwine upload dist/*\n```\n\nNow your package name is reserved and a v0.0.0 placeholder is deployed on PyPI.\n\n## Recommendations\n\n- Once you start the actual development, replace this README with one that describes your package's functionality.\n- Add a `LICENSE` file appropriate for your project.\n- Update the `requirements.txt` and `setup.py` as your project evolves.\n\n## Support\n\nFor issues and feature requests related to this template, please open an issue on GitHub.\n\n## License\n\nThis project is licensed under the AGPL-3.0 License. For more details, see the [LICENSE](LICENSE) file.\n",
"bugtrack_url": null,
"license": "AGPL-3.0",
"summary": "A placeholder for future Ultralytics projects.",
"version": "0.0.0",
"project_urls": {
"Bug Reports": "https://github.com/ultralytics/pip/issues",
"Funding": "https://ultralytics.com",
"Homepage": "https://github.com/ultralytics/pip",
"Source": "https://github.com/ultralytics/pip"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "def1586caf07545457de8377b62eeaab0858fa8f919564e9f7a2e708c8348c7c",
"md5": "228b35ba062bedb75af804c505c1ed99",
"sha256": "5b159a16a708b95ecaf6788b678f9ec7197f17857ec3cd3773450b698842c0e3"
},
"downloads": -1,
"filename": "ultralytics_hub_sdk-0.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "228b35ba062bedb75af804c505c1ed99",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 18594,
"upload_time": "2023-09-08T14:52:51",
"upload_time_iso_8601": "2023-09-08T14:52:51.742689Z",
"url": "https://files.pythonhosted.org/packages/de/f1/586caf07545457de8377b62eeaab0858fa8f919564e9f7a2e708c8348c7c/ultralytics_hub_sdk-0.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cba9f45c688ba8cf26309de42c63344028b979a679275754a2815bd25394a2b3",
"md5": "3696a255af9639410940d2570f092c58",
"sha256": "1ee7b9eac44c5a432d5404da018012c202019c4435c0a3242013b3c0d15369d4"
},
"downloads": -1,
"filename": "ultralytics-hub-sdk-0.0.0.tar.gz",
"has_sig": false,
"md5_digest": "3696a255af9639410940d2570f092c58",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 18010,
"upload_time": "2023-09-08T14:52:53",
"upload_time_iso_8601": "2023-09-08T14:52:53.076666Z",
"url": "https://files.pythonhosted.org/packages/cb/a9/f45c688ba8cf26309de42c63344028b979a679275754a2815bd25394a2b3/ultralytics-hub-sdk-0.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-08 14:52:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ultralytics",
"github_project": "pip",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "numpy",
"specs": [
[
">=",
"1.18.5"
]
]
},
{
"name": "build",
"specs": []
},
{
"name": "twine",
"specs": []
}
],
"lcname": "ultralytics-hub-sdk"
}
JSON
