SECURITY.md (#24)

* doc : TOC removed from README.md

* doc : SECURITY.md updated

* fix : version_check.py updated

* doc : CHANGELOG.md updated

* doc : project email address updated

* doc : AUTHORS.md updated

* doc : SECURITY.md version fixed

* fix : macOS and Windows versions fixed

* doc : RELEASE.md updated

* doc : minor edit in README.md titles

* doc : minor edit in README.md

* doc : minor edit in README.md

.github/CODE_OF_CONDUCT.md

@@ -57,8 +57,7 @@ representative at an online or offline event.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at
-[email protected].
+reported to the community leaders responsible for enforcement at [email protected].
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the

.github/workflows/test.yml

@@ -15,7 +15,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-20.04, windows-latest, macOS-latest]
+        os: [ubuntu-20.04, windows-2022, macOS-13]
         python-version: [3.7, 3.8, 3.9, 3.10.0, 3.11.0, 3.12.0]
     steps:
       - uses: actions/checkout@v2

AUTHORS.md

@@ -1,10 +1,10 @@
-# Authors #
+# Core Developers
 
 ----------
 - AmirHosein Rostami  - Open Science Laboratory ([Github](https://github.com/AHReccese)) **
 - Sepand Haghighi - Open Science Laboratory ([Github](https://github.com/sepandhaghighi))
 
 ** **Maintainer**
 
-# Other Contributors #
+# Other Contributors
 ----------

CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - `feature_request.yml` template
 - `config.yml` for issue template
 - `batch_upload` method added to `PyPIUploader`
+- `SECURITY.md`
 ### Changed
 - Bug report template modified
 - `Uploader` changed to `PyPIUploader`

README.md

@@ -10,24 +10,12 @@
 
 ----------
 
-## 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 
+**⚠️ Warning ⚠️**
+
 <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.
+
+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
@@ -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: <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>
+1. <a href="https://www.flaticon.com/free-icons/box" title="box icons">Box icons created by Good Ware - Flaticon</a>
+2. <a href="https://www.flaticon.com/free-icons/reserved" title="reserved icons">Reserved icons created by Freepik - Flaticon</a>
 
 
 ## Show your support

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 [[email protected]](mailto:[email protected] "[email protected]").
+
+If the security vulnerability is accepted, a dedicated bugfix release will be issued as soon as possible (depending on the complexity of the fix).

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`)

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
 }

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",