<div align="center">
<img src="https://github.com/openscilab/reserver/raw/main/otherfiles/reserver.png" width="300" height="300">
<br/>
<br/>
<a href="https://codecov.io/gh/openscilab/reserver">
<img src="https://codecov.io/gh/openscilab/reserver/branch/main/graph/badge.svg" alt="Codecov"/>
</a>
<a href="https://badge.fury.io/py/reserver">
<img src="https://badge.fury.io/py/reserver.svg" alt="PyPI version" height="18">
</a>
<a href="https://www.python.org/">
<img src="https://img.shields.io/badge/built%20with-Python3-green.svg" alt="built with Python3">
</a>
<a href="https://discord.gg/RD2y6SGuY3">
<img src="https://img.shields.io/discord/1064533716615049236.svg" alt="Discord Channel">
</a>
</div>
----------
## Table of contents
* [Disclaimer](https://github.com/openscilab/reserver#disclaimer)
* [Overview](https://github.com/openscilab/reserver#overview)
* [Installation](https://github.com/openscilab/reserver#installation)
* [Usage](https://github.com/openscilab/reserver#usage)
* [Issues & Bug Reports](https://github.com/openscilab/reserver#issues--bug-reports)
* [Todo](https://github.com/openscilab/reserver/blob/main/TODO.md)
* [Contribution](https://github.com/openscilab/reserver/blob/main/.github/CONTRIBUTING.md)
* [Authors](https://github.com/openscilab/reserver/blob/main/AUTHORS.md)
* [License](https://github.com/openscilab/reserver/blob/main/LICENSE)
* [Show Your Support](https://github.com/openscilab/reserver#show-your-support)
* [Changelog](https://github.com/openscilab/reserver/blob/main/CHANGELOG.md)
* [Code of Conduct](https://github.com/openscilab/reserver/blob/main/.github/CODE_OF_CONDUCT.md)
## Disclaimer
<p align="justify">
⚠️The intention of this package is facilitating the reservation of package names on PyPI for legitimate and appropriate purposes. We explicitly disclaim any responsibility for the misuse or spamming of this tool, particularly in the excessive reservation of package names. Users are advised to be cautious and ensure the legitimate use of this package to avoid potential consequences such as the suspension of their PyPI account. By using this package, users acknowledge and agree to these terms.
</p>
## Overview
<p align="justify">
Reserver is an open source Python package that offers the ability to quickly reserve a PyPI package name. Got a notion? Before it's taken, immediately reserve the product name!
</p>
<table>
<tr>
<td align="center">PyPI Counter</td>
<td align="center">
<a href="http://pepy.tech/project/reserver">
<img src="http://pepy.tech/badge/reserver">
</a>
</td>
</tr>
<tr>
<td align="center">Github Stars</td>
<td align="center">
<a href="https://github.com/openscilab/reserver">
<img src="https://img.shields.io/github/stars/openscilab/reserver.svg?style=social&label=Stars">
</a>
</td>
</tr>
</table>
<table>
<tr>
<td align="center">Branch</td>
<td align="center">main</td>
<td align="center">dev</td>
</tr>
<tr>
<td align="center">CI</td>
<td align="center">
<img src="https://github.com/openscilab/reserver/workflows/CI/badge.svg?branch=main">
</td>
<td align="center">
<img src="https://github.com/openscilab/reserver/workflows/CI/badge.svg?branch=dev">
</td>
</tr>
</table>
## Installation
### PyPI
- Check [Python Packaging User Guide](https://packaging.python.org/installing/)
- Run `pip install reserver==0.1`
### Source code
- Download [Version 0.1](https://github.com/openscilab/reserver/archive/v0.1.zip) or [Latest Source](https://github.com/openscilab/reserver/archive/dev.zip)
- Run `pip install .`
## Usage
### Secure your desired PyPI package name!
```python
from reserver import Uploader
uploader = Uploader(PYPI_API_TOKEN, test_pypi= False)
uploader.upload_to_pypi("CONSIDERED_NAME_FOR_YOUR_PACKAGE")
```
## Issues & bug reports
Just fill an issue and describe it. We'll check it ASAP! or send an email to [info@openscilab.com](mailto:info@openscilab.com "info@openscilab.com").
- Please complete the issue template
You can also join our discord server
<a href="https://discord.gg/RD2y6SGuY3">
<img src="https://img.shields.io/discord/1064533716615049236.svg?style=for-the-badge" alt="Discord Channel">
</a>
## References
### flaticon.com
+ box: <a href="https://www.flaticon.com/free-icons/box" title="box icons">Box icons created by Good Ware - Flaticon</a>
+ reserve plate: <a href="https://www.flaticon.com/free-icons/reserved" title="reserved icons">Reserved icons created by Freepik - Flaticon</a>
## Show your support
### Star this repo
Give a ⭐️ if this project helped you!
### Donate to our project
If you do like our project and we hope that you do, can you please support us? Our project is not and is never going to be working for profit. We need the money just so we can continue doing what we do ;-) .
<a href="https://openscilab.com/#donation" target="_blank"><img src="https://github.com/openscilab/reserver/raw/main/otherfiles/donation.png" height="90px" width="270px" alt="Reserver Donation"></a>
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
## [Unreleased]
### Added
### Changed
## [0.1] - 2024-02-07
### Added
- `Uploader` class
- Check package name existence
- Upload template package to test.pypi
- Upload template package to pypi
- Generate template package for a given name
- Handle similiar name existance in pypi
- Handle issue with "-" character `.egginfo` file name
[Unreleased]: https://github.com/openscilab/reserver/compare/v0.1...dev
[0.1]: https://github.com/openscilab/reserver/compare/0ae5bb9...v0.1
Raw data
{
"_id": null,
"home_page": "https://github.com/openscilab/reserver",
"name": "reserver",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "python3 python PyPI pip package name reservation",
"author": "Reserver Development Team",
"author_email": "info@openscilab.com",
"download_url": "https://files.pythonhosted.org/packages/52/62/017985189c1c00a31697372587b733a0bd464b43647e452983a781841f6c/reserver-0.1.tar.gz",
"platform": null,
"description": "\n<div align=\"center\">\n <img src=\"https://github.com/openscilab/reserver/raw/main/otherfiles/reserver.png\" width=\"300\" height=\"300\">\n <br/>\n <br/>\n <a href=\"https://codecov.io/gh/openscilab/reserver\">\n <img src=\"https://codecov.io/gh/openscilab/reserver/branch/main/graph/badge.svg\" alt=\"Codecov\"/>\n </a>\n <a href=\"https://badge.fury.io/py/reserver\">\n <img src=\"https://badge.fury.io/py/reserver.svg\" alt=\"PyPI version\" height=\"18\">\n </a>\n <a href=\"https://www.python.org/\">\n <img src=\"https://img.shields.io/badge/built%20with-Python3-green.svg\" alt=\"built with Python3\">\n </a>\n <a href=\"https://discord.gg/RD2y6SGuY3\">\n <img src=\"https://img.shields.io/discord/1064533716615049236.svg\" alt=\"Discord Channel\">\n </a>\n</div>\n\n----------\n\n## Table of contents\n\n* [Disclaimer](https://github.com/openscilab/reserver#disclaimer)\n* [Overview](https://github.com/openscilab/reserver#overview)\n* [Installation](https://github.com/openscilab/reserver#installation)\n* [Usage](https://github.com/openscilab/reserver#usage)\n* [Issues & Bug Reports](https://github.com/openscilab/reserver#issues--bug-reports)\n* [Todo](https://github.com/openscilab/reserver/blob/main/TODO.md)\n* [Contribution](https://github.com/openscilab/reserver/blob/main/.github/CONTRIBUTING.md)\n* [Authors](https://github.com/openscilab/reserver/blob/main/AUTHORS.md)\n* [License](https://github.com/openscilab/reserver/blob/main/LICENSE)\n* [Show Your Support](https://github.com/openscilab/reserver#show-your-support)\n* [Changelog](https://github.com/openscilab/reserver/blob/main/CHANGELOG.md)\n* [Code of Conduct](https://github.com/openscilab/reserver/blob/main/.github/CODE_OF_CONDUCT.md)\n\n## Disclaimer \n<p align=\"justify\">\n\u26a0\ufe0fThe intention of this package is facilitating the reservation of package names on PyPI for legitimate and appropriate purposes. We explicitly disclaim any responsibility for the misuse or spamming of this tool, particularly in the excessive reservation of package names. Users are advised to be cautious and ensure the legitimate use of this package to avoid potential consequences such as the suspension of their PyPI account. By using this package, users acknowledge and agree to these terms.\n</p>\n\n## Overview\n<p align=\"justify\">\nReserver is an open source Python package that offers\u00a0the\u00a0ability\u00a0to\u00a0quickly\u00a0reserve\u00a0a\u00a0PyPI\u00a0package\u00a0name. Got\u00a0a\u00a0notion? Before\u00a0it's\u00a0taken,\u00a0immediately\u00a0reserve\u00a0the\u00a0product\u00a0name!\n</p>\n<table>\n <tr>\n <td align=\"center\">PyPI Counter</td>\n <td align=\"center\">\n <a href=\"http://pepy.tech/project/reserver\">\n <img src=\"http://pepy.tech/badge/reserver\">\n </a>\n </td>\n </tr>\n <tr>\n <td align=\"center\">Github Stars</td>\n <td align=\"center\">\n <a href=\"https://github.com/openscilab/reserver\">\n <img src=\"https://img.shields.io/github/stars/openscilab/reserver.svg?style=social&label=Stars\">\n </a>\n </td>\n </tr>\n</table>\n<table>\n <tr> \n <td align=\"center\">Branch</td>\n <td align=\"center\">main</td>\n <td align=\"center\">dev</td>\n </tr>\n <tr>\n <td align=\"center\">CI</td>\n <td align=\"center\">\n <img src=\"https://github.com/openscilab/reserver/workflows/CI/badge.svg?branch=main\">\n </td>\n <td align=\"center\">\n <img src=\"https://github.com/openscilab/reserver/workflows/CI/badge.svg?branch=dev\">\n </td>\n </tr>\n</table>\n\n\n## Installation\n\n### PyPI\n\n- Check [Python Packaging User Guide](https://packaging.python.org/installing/)\n- Run `pip install reserver==0.1`\n### Source code\n- Download [Version 0.1](https://github.com/openscilab/reserver/archive/v0.1.zip) or [Latest Source](https://github.com/openscilab/reserver/archive/dev.zip)\n- Run `pip install .`\n\n## Usage\n### Secure your desired PyPI package name!\n```python\nfrom reserver import Uploader\nuploader = Uploader(PYPI_API_TOKEN, test_pypi= False)\nuploader.upload_to_pypi(\"CONSIDERED_NAME_FOR_YOUR_PACKAGE\")\n```\n\n## Issues & bug reports\n\nJust fill an issue and describe it. We'll check it ASAP! or send an email to [info@openscilab.com](mailto:info@openscilab.com \"info@openscilab.com\"). \n\n- Please complete the issue template\n \nYou can also join our discord server\n\n<a href=\"https://discord.gg/RD2y6SGuY3\">\n <img src=\"https://img.shields.io/discord/1064533716615049236.svg?style=for-the-badge\" alt=\"Discord Channel\">\n</a>\n\n## References\n\n### flaticon.com\n+ box: <a href=\"https://www.flaticon.com/free-icons/box\" title=\"box icons\">Box icons created by Good Ware - Flaticon</a>\n+ reserve plate: <a href=\"https://www.flaticon.com/free-icons/reserved\" title=\"reserved icons\">Reserved icons created by Freepik - Flaticon</a>\n\n\n## Show your support\n\n### Star this repo\nGive a \u2b50\ufe0f if this project helped you!\n\n### Donate to our project\nIf you do like our project and we hope that you do, can you please support us? Our project is not and is never going to be working for profit. We need the money just so we can continue doing what we do ;-) .\t\t\t\n\n<a href=\"https://openscilab.com/#donation\" target=\"_blank\"><img src=\"https://github.com/openscilab/reserver/raw/main/otherfiles/donation.png\" height=\"90px\" width=\"270px\" alt=\"Reserver Donation\"></a>\n# Changelog\nAll notable changes to this project will be documented in this file.\n\nThe format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)\nand this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).\n\n## [Unreleased]\n### Added\n### Changed\n## [0.1] - 2024-02-07\n### Added\n- `Uploader` class\n- Check package name existence\n- Upload template package to test.pypi\n- Upload template package to pypi\n- Generate template package for a given name\n- Handle similiar name existance in pypi\n- Handle issue with \"-\" character `.egginfo` file name\n\n[Unreleased]: https://github.com/openscilab/reserver/compare/v0.1...dev\n[0.1]: https://github.com/openscilab/reserver/compare/0ae5bb9...v0.1\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "PyPI package name reserver",
"version": "0.1",
"project_urls": {
"Download": "https://github.com/openscilab/reserver/tarball/v0.1",
"Homepage": "https://github.com/openscilab/reserver",
"Source": "https://github.com/openscilab/reserver"
},
"split_keywords": [
"python3",
"python",
"pypi",
"pip",
"package",
"name",
"reservation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d57303348a1ee241a11c02c384fca239ca8e5a279799b0dc5a19ccdafc072e37",
"md5": "d01a4f3f01fc497b488f4ec8c95fa8fb",
"sha256": "ad50400f0e6b1115abdcd682c45d67f52c9a30f5b9d17a0d9b47ad55833090ab"
},
"downloads": -1,
"filename": "reserver-0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d01a4f3f01fc497b488f4ec8c95fa8fb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 8103,
"upload_time": "2024-02-07T14:14:03",
"upload_time_iso_8601": "2024-02-07T14:14:03.571173Z",
"url": "https://files.pythonhosted.org/packages/d5/73/03348a1ee241a11c02c384fca239ca8e5a279799b0dc5a19ccdafc072e37/reserver-0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5262017985189c1c00a31697372587b733a0bd464b43647e452983a781841f6c",
"md5": "f28f3eedad99031c94c8dbcc9c069b61",
"sha256": "3ab1b7c73d97e28fc0848dd91fb33583463673681302c5d2b06f358c12f9bf49"
},
"downloads": -1,
"filename": "reserver-0.1.tar.gz",
"has_sig": false,
"md5_digest": "f28f3eedad99031c94c8dbcc9c069b61",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 8169,
"upload_time": "2024-02-07T14:14:00",
"upload_time_iso_8601": "2024-02-07T14:14:00.291664Z",
"url": "https://files.pythonhosted.org/packages/52/62/017985189c1c00a31697372587b733a0bd464b43647e452983a781841f6c/reserver-0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-07 14:14:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "openscilab",
"github_project": "reserver",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "reserver"
}
JSON
