{"id":23967936,"url":"https://github.com/openscilab/reserver","last_synced_at":"2025-04-13T15:12:53.848Z","repository":{"id":218207252,"uuid":"742727727","full_name":"openscilab/reserver","owner":"openscilab","description":"Got a notion? Before it's taken, immediately reserve the product name in PyPi (pip)!","archived":false,"fork":false,"pushed_at":"2025-04-01T19:06:28.000Z","size":242,"stargazers_count":24,"open_issues_count":5,"forks_count":3,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-04-13T15:12:48.983Z","etag":null,"topics":["pypi","pypi-package","python","reserve","reserver"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openscilab.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":"AUTHORS.md","dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-01-13T07:21:13.000Z","updated_at":"2025-04-11T18:31:02.000Z","dependencies_parsed_at":"2024-02-07T14:45:27.773Z","dependency_job_id":"0db2a3d3-8d6f-4597-90ca-f7c346e571e3","html_url":"https://github.com/openscilab/reserver","commit_stats":null,"previous_names":["openscilab/reserver"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openscilab%2Freserver","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openscilab%2Freserver/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openscilab%2Freserver/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openscilab%2Freserver/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openscilab","download_url":"https://codeload.github.com/openscilab/reserver/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248732487,"owners_count":21152852,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["pypi","pypi-package","python","reserve","reserver"],"created_at":"2025-01-06T23:57:11.042Z","updated_at":"2025-04-13T15:12:53.825Z","avatar_url":"https://github.com/openscilab.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n    \u003cimg src=\"https://github.com/openscilab/reserver/raw/main/otherfiles/reserver.png\" width=\"300\" height=\"300\"\u003e\n    \u003cbr/\u003e\n    \u003cbr/\u003e\n    \u003ca href=\"https://codecov.io/gh/openscilab/reserver\"\u003e\u003cimg src=\"https://codecov.io/gh/openscilab/reserver/branch/main/graph/badge.svg\" alt=\"Codecov\"/\u003e\u003c/a\u003e\n    \u003ca href=\"https://badge.fury.io/py/reserver\"\u003e\u003cimg src=\"https://badge.fury.io/py/reserver.svg\" alt=\"PyPI version\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://www.python.org/\"\u003e\u003cimg src=\"https://img.shields.io/badge/built%20with-Python3-green.svg\" alt=\"built with Python3\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/openscilab/reserver\"\u003e\u003cimg alt=\"GitHub repo size\" src=\"https://img.shields.io/github/repo-size/openscilab/reserver\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://discord.gg/RD2y6SGuY3\"\u003e\u003cimg src=\"https://img.shields.io/discord/1064533716615049236.svg\" alt=\"Discord Channel\"\u003e\u003c/a\u003e\n\u003c/div\u003e\n\n----------\n\n## Disclaimer \n**⚠️ Warning ⚠️**\n\n\u003cp align=\"justify\"\u003e\n\nThe 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\u003c/p\u003e\n\n## Overview\n\u003cp align=\"justify\"\u003e\nReserver 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!\n\u003c/p\u003e\n\u003ctable\u003e\n    \u003ctr\u003e\n        \u003ctd align=\"center\"\u003ePyPI Counter\u003c/td\u003e\n        \u003ctd align=\"center\"\u003e\n            \u003ca href=\"https://pepy.tech/projects/reserver\"\u003e\n                \u003cimg src=\"https://static.pepy.tech/badge/reserver\" alt=\"PyPI Downloads\"\u003e\n            \u003c/a\u003e\n        \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd align=\"center\"\u003eGithub Stars\u003c/td\u003e\n        \u003ctd align=\"center\"\u003e\n            \u003ca href=\"https://github.com/openscilab/reserver\"\u003e\n                \u003cimg src=\"https://img.shields.io/github/stars/openscilab/reserver.svg?style=social\u0026label=Stars\"\u003e\n            \u003c/a\u003e\n        \u003c/td\u003e\n    \u003c/tr\u003e\n\u003c/table\u003e\n\u003ctable\u003e\n    \u003ctr\u003e \n        \u003ctd align=\"center\"\u003eBranch\u003c/td\u003e\n        \u003ctd align=\"center\"\u003emain\u003c/td\u003e\n        \u003ctd align=\"center\"\u003edev\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd align=\"center\"\u003eCI\u003c/td\u003e\n        \u003ctd align=\"center\"\u003e\n            \u003cimg src=\"https://github.com/openscilab/reserver/actions/workflows/test.yml/badge.svg?branch=main\"\u003e\n        \u003c/td\u003e\n        \u003ctd align=\"center\"\u003e\n            \u003cimg src=\"https://github.com/openscilab/reserver/actions/workflows/test.yml/badge.svg?branch=dev\"\u003e\n            \u003c/td\u003e\n    \u003c/tr\u003e\n\u003c/table\u003e\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.4`\n### Source code\n- Download [Version 0.4](https://github.com/openscilab/reserver/archive/v0.4.zip) or [Latest Source](https://github.com/openscilab/reserver/archive/dev.zip)\n- Run `pip install .`\n\n## Usage\n\n### Programmatically \nReserve a package name in main PyPI (pypi.org)\n```python\nfrom reserver import PyPIUploader\nuploader = PyPIUploader(PYPI_TOKEN, test_pypi=False)\nuploader.upload(\"CONSIDERED_NAME_FOR_YOUR_PACKAGE\")\n```\nReserve batch of names with custom user-defined parameters in test PyPI (test.pypi.org)\n```python\nuploader = PyPIUploader(TEST_PYPI_TOKEN, test_pypi=True)\nuploader.batch_upload([\"PACKAGE_NAME_1\", \"PACKAGE_NAME_2\"], [\"config1.json\", \"config2.json\"])\n```\n### CLI\nℹ️ You can use `reserver` or `python -m reserver` to run this program\n#### Version\n```console\nreserver -v\nreserver --version\n```\n#### Reserve in test PyPI (test.pypi.org)\n```console\nreserver --name sample_name1 sample_name2 --token=TEST_PYPI_TOKEN --test\n```\n#### Reserve in main PyPI (pypi.org)\n```console\nreserver --name sample_name1 sample_name2 --token=PYPI_TOKEN\n```\n#### Customizing package parameters\n\nYou can customize the following package parameters for reservations on PyPI using the Reserver CLI. The details and defaults are provided in the table below.\n\n| Parameter | Type | Default | Description |\n|---|---|---|---|\n| `description` | string | `This name has been reserved using Reserver` | A short description of your PyPI package name reservation. |\n| `author` | string | `Development Team` | The name of the author or development team. |\n| `author_email` | email address | `test@test.com` | An email address for contact. |\n| `url` | web address | `https://url.com` | The project's main repository URL. |\n| `download_url` | web address | `https://download_url.com` | The download URL for the package. |\n| `source` | web address | `https://github.com/source` | The source code repository URL. |\n| `license` | string | `MIT` | The license under which your package is distributed. |\n\nThere are two ways to define these custom parameters:\n\n**1. Single `param.json` for all packages:**\n\nThis approach uses a single JSON file (`param.json`) to define common parameters for all packages. This file could hold information like those described in the table.\n\nHere's how to use this method:\n\n```console\nreserver --name sample_name1 sample_name2 --param config.json --token=PYPI_TOKEN\n```\n**2. Dedicated `param.json` per package:**\n\nThis approach allows for more customization by having a separate JSON file for each package. Each file would contain parameters specific to that particular package.\n\nHere's how this method works:\n\n```console\nreserver --name sample_name1 sample_name2 --param name1_param.json name2_param.json --token=PYPI_TOKEN\n```\n\nChoose the method that best suits your needs. Using a single `param.json` is efficient for packages with similar information, while separate files offer more granular control.\n\nℹ️ You can use all available features on both `pypi.org` and `test.pypi.org`.\n## Issues \u0026 bug reports\n\nJust fill an issue and describe it. We'll check it ASAP! or send an email to [reserver@openscilab.com](mailto:reserver@openscilab.com \"reserver@openscilab.com\"). \n\n- Please complete the issue template\n \nYou can also join our discord server\n\n\u003ca href=\"https://discord.gg/RD2y6SGuY3\"\u003e\u003cimg src=\"https://img.shields.io/discord/1064533716615049236.svg?style=for-the-badge\" alt=\"Discord Channel\"\u003e\u003c/a\u003e\n\n## Show your support\n\n### Star this repo\nGive a ⭐️ 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\u003ca href=\"https://openscilab.com/#donation\" target=\"_blank\"\u003e\u003cimg src=\"https://github.com/openscilab/reserver/raw/main/otherfiles/donation.png\" height=\"90px\" width=\"270px\" alt=\"Reserver Donation\"\u003e\u003c/a\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenscilab%2Freserver","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenscilab%2Freserver","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenscilab%2Freserver/lists"}