-⚠️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. + +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.
## Overview @@ -81,7 +69,7 @@ Reserver is an open source Python package that offers the ability to quickly - Run `pip install .` ## Usage -### Secure your desired PyPI package name! + ```python from reserver import PyPIUploader uploader = PyPIUploader(PYPI_API_TOKEN, test_pypi= False) @@ -90,7 +78,7 @@ uploader.upload("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"). +Just 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"). - Please complete the issue template @@ -100,9 +88,8 @@ You can also join our discord server ## References -### flaticon.com -+ box: Box icons created by Good Ware - Flaticon -+ reserve plate: Reserved icons created by Freepik - Flaticon +1. Box icons created by Good Ware - Flaticon +2. Reserved icons created by Freepik - Flaticon ## Show your support diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..3f47b7d --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,14 @@ +# Security policy + +## Supported versions + +| Version | Supported | +| ------------- | ------------------ | +| 0.1 | :white_check_mark: | +| < 0.1 | :x: | + +## Reporting a vulnerability + +Please report security vulnerabilities by email to [reserver@openscilab.com](mailto:reserver@openscilab.com "reserver@openscilab.com"). + +If the security vulnerability is accepted, a dedicated bugfix release will be issued as soon as possible (depending on the complexity of the fix). \ No newline at end of file diff --git a/otherfiles/RELEASE.md b/otherfiles/RELEASE.md index 28e98cd..b8fb601 100644 --- a/otherfiles/RELEASE.md +++ b/otherfiles/RELEASE.md @@ -1,14 +1,15 @@ # Reserver Release Instructions -#### Last Update: 2024-04-19 +**Last Update: 2024-04-27** 1. Create the `release` branch under `dev` 2. Update all version tags 1. `setup.py` 2. `README.md` - 3. `otherfiles/version_check.py` - 4. `otherfiles/meta.yaml` - 5. `reserver/reserver_param.py` + 3. `SECURITY.md` + 4. `otherfiles/version_check.py` + 5. `otherfiles/meta.yaml` + 6. `reserver/reserver_param.py` 3. Update `CHANGELOG.md` 1. Add a new header under `Unreleased` section (Example: `## [0.1] - 2022-08-17`) 2. Add a new compare link to the end of the file (Example: `[0.2]: https://github.com/openscilab/reserver/compare/v0.1...v0.2`) diff --git a/otherfiles/version_check.py b/otherfiles/version_check.py index 886acaf..558f10e 100644 --- a/otherfiles/version_check.py +++ b/otherfiles/version_check.py @@ -20,12 +20,14 @@ PARAMS_ITEMS = ['RESERVER_VERSION = "{0}"'] META_ITEMS = ['% set version = "{0}" %'] ISSUE_TEMPLATE_ITEMS = ["- Reserver {0}"] +SECURITY_ITEMS = ["| {0} | :white_check_mark: |", "| < {0} | :x: |"] FILES = { os.path.join("otherfiles", "meta.yaml"): META_ITEMS, "setup.py": SETUP_ITEMS, "README.md": README_ITEMS, "CHANGELOG.md": CHANGELOG_ITEMS, + "SECURITY.md": SECURITY_ITEMS, os.path.join("reserver", "reserver_param.py"): PARAMS_ITEMS, os.path.join(".github", "ISSUE_TEMPLATE", "bug_report.yml"): ISSUE_TEMPLATE_ITEMS } diff --git a/setup.py b/setup.py index 45ff619..5daf019 100644 --- a/setup.py +++ b/setup.py @@ -34,7 +34,7 @@ def read_description(): long_description=read_description(), long_description_content_type='text/markdown', author='Reserver Development Team', - author_email='info@openscilab.com', + author_email='reserver@openscilab.com', url='https://github.com/openscilab/reserver', download_url='https://github.com/openscilab/reserver/tarball/v0.1', keywords="python3 python PyPI pip package name reservation",