reserver 0.0.0__tar.gz

reserver-0.0.0/AUTHORS.md

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

reserver-0.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 OpenSciLab
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

reserver-0.0.0/PKG-INFO

@@ -0,0 +1,27 @@
+Metadata-Version: 2.1
+Name: reserver
+Version: 0.0.0
+Summary: This name has been reserved using Reserver
+Home-page: https://url.com
+Download-URL: https://download_url.com
+Author: Development Team
+Author-email: test@test.com
+License: MIT
+Project-URL: Source, https://github.com/source
+Keywords: python3 python reserve reserver reserved
+Classifier: Development Status :: 1 - Planning
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: AUTHORS.md
+
+
+    This name has been reserved using [Reserver](https://github.com/openscilab/reserver).
+    

reserver-0.0.0/README.md

@@ -0,0 +1,117 @@
+<div align="center">
+    <img src="https://github.com/openscilab/reserver/raw/main/otherfiles/logo.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="TODO">
+        <img src="TODO" 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
+
+* [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)
+
+
+## Overview
+<p align="justify">
+Reserver is an open source Python package that provides functionality to easily reserve a pypi package name. Have an idea? Reserve the package name instantly before it gets taken!
+</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, is_test_pypi_account= 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>
+
+
+## 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>

reserver-0.0.0/reserver/__init__.py

@@ -0,0 +1,6 @@
+# -*- coding: utf-8 -*-
+"""Reserver modules."""
+from .reserver_param import RESERVER_VERSION
+from .reserver_obj import Uploader
+
+__version__ = RESERVER_VERSION

reserver-0.0.0/reserver/reserver_func.py

@@ -0,0 +1,93 @@
+# -*- coding: utf-8 -*-
+"""Reserver Functions."""
+from requests import get
+from .reserver_param import PYPI_TEST_URL, PYPI_MAIN_URL
+from hashlib import sha256
+from time import time
+
+
+def get_random_name():
+    """
+    Generate a random str based on current timestamp.
+
+    :return: str
+    """
+    return sha256(str(time()).encode("utf-8")).hexdigest()
+
+
+def does_package_exist(suggested_name, test_pypi):
+    """
+    Check whether a package with the given name exists or not.
+
+    :param suggested_name: given name to search in pypi(or test.pypi)
+    :type suggested_name: str
+    :param test_pypi: indicates to search in test.pypi or not
+    :type test_pypi: bool
+    :return: whether given name does exist in the pypi or not(as a boolean value)
+    """
+    if not isinstance(suggested_name, str):
+        suggested_name = str(suggested_name)
+    if test_pypi:
+        url = PYPI_TEST_URL + "/" + suggested_name + "/"
+    else:
+        url = PYPI_MAIN_URL + "/" + suggested_name + "/"
+    response = get(url, timeout=5)
+    return not response.status_code == 404
+
+
+def generate_template_setup_py(package_name):
+    """
+    Generate a template `setup.py` file for given package name.
+
+    :param package_name: given name to generate template `setup.py` for it.
+    :type package_name: str
+    :return: None
+    """
+    setup_py_content = """
+import sys
+
+try:
+    from setuptools import setup
+except ImportError:
+    from distutils.core import setup
+
+# invalid email
+# download url
+# url
+# project urls
+
+setup(
+    name =""" + "\"" + package_name + "\"" + """,
+    packages=[],
+    version='0.0.0',
+    description='This name has been reserved using Reserver',
+    long_description=\"\"\"
+    This name has been reserved using [Reserver](https://github.com/openscilab/reserver).
+    \"\"\",
+    long_description_content_type='text/markdown',
+    author='Development Team',
+    author_email='test@test.com',
+    url='https://url.com',
+    download_url='https://download_url.com',
+    keywords="python3 python reserve reserver reserved",
+    project_urls={
+            'Source': 'https://github.com/source',
+    },
+    install_requires="",
+    python_requires='>=3.6',
+    classifiers=[
+        \'Development Status :: 1 - Planning\',
+        \'Programming Language :: Python :: 3.6\',
+        \'Programming Language :: Python :: 3.7\',
+        \'Programming Language :: Python :: 3.8\',
+        \'Programming Language :: Python :: 3.9\',
+        \'Programming Language :: Python :: 3.10\',
+        \'Programming Language :: Python :: 3.11\',
+        \'Programming Language :: Python :: 3.12\',
+    ],
+    license='MIT',
+)
+
+"""
+    with open(package_name + "_setup.py", "w+") as f:
+        f.writelines(setup_py_content)

reserver-0.0.0/reserver/reserver_obj.py

@@ -0,0 +1,95 @@
+# -*- coding: utf-8 -*-
+"""Reserver modules."""
+from .reserver_func import does_package_exist, generate_template_setup_py
+from os import environ, path, getcwd, remove
+from shutil import rmtree
+from sys import executable
+from subprocess import check_output, CalledProcessError
+
+
+class Uploader:
+    """
+    The Reserver Uploader class reserves a package name by uploading a template repo to pypi account.
+
+    >>> uploader = Uploader(API_TOKEN, is_test_pypi_account = True) # API_TOKEN refers to pypi(or test pypi)'s account api.
+    >>> uploader.upload_to_pypi(PACKAGE_NAME) # uploads package to the given test pypi account.
+    """
+
+    def __init__(self, api_token, is_test_pypi_account=False):
+        """
+        Initialize the Reserver Uploader instance.
+
+        :param api_token: pypi account's api token
+        :type api_token: str
+        :param is_test_pypi_account: indicates the given api_token is for a test.pypi account or not.
+        :type is_test_pypi_account: bool
+        :return: an instance of the Reserver Uploader
+        """
+        self.username = "__token__"
+        self.password = api_token
+        self.test_pypi = is_test_pypi_account
+
+    def upload_to_pypi(self, package_name):
+        """
+        Upload a template package to pypi or test_pypi.
+
+        :param package_name: package name
+        :type package_name: str
+        :return: None
+        """
+        if does_package_exist(package_name, self.test_pypi):
+            print("This package already exists in PyPI.")
+            return False 
+        
+        generate_template_setup_py(package_name)
+
+        environ["TWINE_USERNAME"] = self.username
+        environ["TWINE_PASSWORD"] = self.password
+
+        generated_setup_file_path = path.join(getcwd(), package_name + "_setup.py")
+        generated_egginfo_file_path = path.join(getcwd(), package_name + ".egg-info")
+        generated_built_folder = path.join(getcwd(), "build")
+        generated_dist_folder = path.join(getcwd(), "dist")
+        generated_tar_gz_file = path.join(generated_dist_folder, "*.tar.gz")
+        generated_wheel_file = path.join(generated_dist_folder, "*.whl")
+        # prevent from uploading any other previously build library in this path.
+        if path.exists(generated_dist_folder):
+            rmtree(generated_dist_folder)
+
+        commands = [executable + " " + generated_setup_file_path + " sdist bdist_wheel "]
+        if self.test_pypi:
+            commands += [
+                executable + " -m twine upload --repository testpypi " + generated_tar_gz_file,
+                executable + " -m twine upload --repository testpypi " + generated_wheel_file,
+            ]
+        else:
+            commands += [
+                executable + " -m twine upload --verbose " + generated_tar_gz_file,
+                executable + " -m twine upload --verbose " + generated_wheel_file,
+            ]
+        # Run the commands
+        publish_failed = False
+        error = None
+        for command in commands:
+            print("running this command: ", command)
+            try:
+                check_output(command, shell=True, text=True)
+            except CalledProcessError as e:
+                publish_failed = True
+                error = e.output
+                if command == commands[-2]:
+                    if "403" in error and "Invalid or non-existent authentication information" in error:
+                        error = "Invalid or non-existent authentication information(PyPI API Key)."
+                break 
+
+        remove(generated_setup_file_path)
+        rmtree(generated_egginfo_file_path)
+        rmtree(generated_built_folder)
+        rmtree(generated_dist_folder)
+
+        if publish_failed:
+            print(f"Publish to PyPI failed because of: ", error)
+            return False  
+        else:
+            print("Congratulations! You have successfully reserved the PyPI package: ", package_name)
+            return True 

reserver-0.0.0/reserver/reserver_param.py

@@ -0,0 +1,7 @@
+# -*- coding: utf-8 -*-
+"""Parameters and constants."""
+RESERVER_VERSION = "0.1"
+RESERVER_NAME = "reserver"
+
+PYPI_TEST_URL = "https://test.pypi.org/project"
+PYPI_MAIN_URL = "https://pypi.org/project"

reserver-0.0.0/reserver.egg-info/PKG-INFO

@@ -0,0 +1,27 @@
+Metadata-Version: 2.1
+Name: reserver
+Version: 0.0.0
+Summary: This name has been reserved using Reserver
+Home-page: https://url.com
+Download-URL: https://download_url.com
+Author: Development Team
+Author-email: test@test.com
+License: MIT
+Project-URL: Source, https://github.com/source
+Keywords: python3 python reserve reserver reserved
+Classifier: Development Status :: 1 - Planning
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: AUTHORS.md
+
+
+    This name has been reserved using [Reserver](https://github.com/openscilab/reserver).
+    

reserver-0.0.0/reserver.egg-info/SOURCES.txt

@@ -0,0 +1,14 @@
+AUTHORS.md
+LICENSE
+README.md
+reserver_setup.py
+setup.py
+reserver/__init__.py
+reserver/reserver_func.py
+reserver/reserver_obj.py
+reserver/reserver_param.py
+reserver.egg-info/PKG-INFO
+reserver.egg-info/SOURCES.txt
+reserver.egg-info/dependency_links.txt
+reserver.egg-info/top_level.txt
+tests/test_reserver.py

reserver-0.0.0/reserver.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

reserver-0.0.0/reserver.egg-info/top_level.txt

@@ -0,0 +1 @@
+

reserver-0.0.0/reserver_setup.py

@@ -0,0 +1,45 @@
+
+import sys
+
+try:
+    from setuptools import setup
+except ImportError:
+    from distutils.core import setup
+
+# invalid email
+# download url
+# url
+# project urls
+
+setup(
+    name ="reserver",
+    packages=[],
+    version='0.0.0',
+    description='This name has been reserved using Reserver',
+    long_description="""
+    This name has been reserved using [Reserver](https://github.com/openscilab/reserver).
+    """,
+    long_description_content_type='text/markdown',
+    author='Development Team',
+    author_email='test@test.com',
+    url='https://url.com',
+    download_url='https://download_url.com',
+    keywords="python3 python reserve reserver reserved",
+    project_urls={
+            'Source': 'https://github.com/source',
+    },
+    install_requires="",
+    python_requires='>=3.6',
+    classifiers=[
+        'Development Status :: 1 - Planning',
+        'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7',
+        'Programming Language :: Python :: 3.8',
+        'Programming Language :: Python :: 3.9',
+        'Programming Language :: Python :: 3.10',
+        'Programming Language :: Python :: 3.11',
+        'Programming Language :: Python :: 3.12',
+    ],
+    license='MIT',
+)
+

reserver-0.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

reserver-0.0.0/setup.py

@@ -0,0 +1,69 @@
+# -*- coding: utf-8 -*-
+"""Setup module."""
+try:
+    from setuptools import setup
+except ImportError:
+    from distutils.core import setup
+
+
+def get_requires():
+    """Read requirements.txt."""
+    requirements = open("requirements.txt", "r").read()
+    return list(filter(lambda x: x != "", requirements.split()))
+
+
+def read_description():
+    """Read README.md and CHANGELOG.md."""
+    try:
+        with open("README.md") as r:
+            description = "\n"
+            description += r.read()
+        with open("CHANGELOG.md") as c:
+            description += "\n"
+            description += c.read()
+        return description
+    except Exception:
+        return '''PyPI Package Name Reserver'''
+
+
+setup(
+    name='reserver',
+    packages=[
+        'reserver',],
+    version='0.1',
+    description='PyPI package name reserver',
+    long_description=read_description(),
+    long_description_content_type='text/markdown',
+    author='Reserver Development Team',
+    author_email='info@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",
+    project_urls={
+            'Source': 'https://github.com/openscilab/reserver',
+    },
+    install_requires=get_requires(),
+    python_requires='>=3.6',
+    classifiers=[
+        'Development Status :: 3 - Alpha',
+        'Intended Audience :: Developers',
+        'Natural Language :: English',
+        'License :: OSI Approved :: MIT License',
+        'Operating System :: OS Independent',
+        'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7',
+        'Programming Language :: Python :: 3.8',
+        'Programming Language :: Python :: 3.9',
+        'Programming Language :: Python :: 3.10',
+        'Programming Language :: Python :: 3.11',
+        'Programming Language :: Python :: 3.12',
+        'Intended Audience :: Developers',
+        'Intended Audience :: Education',
+        'Intended Audience :: End Users/Desktop',
+        'Intended Audience :: Manufacturing',
+        'Intended Audience :: Science/Research',
+        'Topic :: Development/Kit :: Package name reservation',
+
+    ],
+    license='MIT',
+)

reserver-0.0.0/tests/test_reserver.py

@@ -0,0 +1,34 @@
+from reserver import Uploader
+from reserver.reserver_func import get_random_name
+
+# main pypi account - to be removed.
+# pypi_token = "pypi-AgEIcHlwaS5vcmcCJDRmNThmNDFkLTZhNTYtNDU2Ny05YjhlLTM4YzNkNTczMDA4NgACKlszLCJiMjNmNjZlYS1iZGEzLTQ4NzYtYTdmNy02ZjZlYjYwM2I4NTMiXQAABiAqGQglXAgXzZUL5Ik-NsC1R8TidtKtZRZzbA32C8KiCA"
+# main pypi account new password: "kwhM8Pp$S@sCx6m"
+
+# test.pypi account
+# test_pypi_token = "pypi-AgENdGVzdC5weXBpLm9yZwIkMTFkZDhjNWMtMTY2My00OWMyLTlmZGItZWZkMzU2NDQxMWJlAAIqWzMsIjJhYjkwZjE4LWQ1ODItNGFiNy05NTYwLWUxN2ZiZTcwY2Y2NyJdAAAGIDVymuINEbiyhSBeB_-ysIapdi_wHTTjD9vpV6mFGzvu"
+# test pypi account new password: "fgtwwU64X7yEE6z"
+
+# AHReccese reserver token: 
+
+import os
+test_pypi_token = os.environ.get("TEST_PYPI_PASSWORD")
+
+def test_package_exists():
+    # test reserved name
+    uploader = Uploader(test_pypi_token, is_test_pypi_account= True)
+    assert uploader.upload_to_pypi("numpy") == False
+
+def test_valid_package_invalid_credentials():
+    # test not reserved name -> wrong credentials
+    wrong_pypi_token = "pypi-wrong-api-token"
+    uploader = Uploader(wrong_pypi_token, is_test_pypi_account= True)
+    assert uploader.upload_to_pypi(get_random_name()) == False
+
+def test_valid_package_valid_credentials():
+    # test not reserved name -> correct credentials
+    pypi_token = "pypi-AgEIcHlwaS5vcmcCJDExMWY5NjljLWQ1MDktNGY3YS1hM2IxLTQ0NDdjMjUzMmM1NAACKlszLCI4YWI5MmU3Mi02ZTJiLTQzM2EtYjA4Ni0wNzYxNGU4NTM2Y2MiXQAABiAGihGds9jq0FdriHsw1q9jq4UY-LmjEyNFgT8lNkaxCg"
+    uploader = Uploader(pypi_token)
+    uploader.upload_to_pypi("reserver")
+    # assert True == True
+test_valid_package_valid_credentials()