v2kit 0.0.0__tar.gz

v2kit-0.0.0/AUTHORS.md

@@ -0,0 +1,14 @@
+# 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
+----------
+- [@boreshnavard](https://github.com/boreshnavard) ++
+- [@sadrasabouri](https://github.com/sadrasabouri)
+
+
+++ Graphic designer

v2kit-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.

v2kit-0.0.0/PKG-INFO

@@ -0,0 +1,25 @@
+Metadata-Version: 2.1
+Name: v2kit
+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).

v2kit-0.0.0/README.md

@@ -0,0 +1,157 @@
+<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"></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://github.com/openscilab/reserver"><img alt="GitHub repo size" src="https://img.shields.io/github/repo-size/openscilab/reserver"></a>
+    <a href="https://discord.gg/RD2y6SGuY3"><img src="https://img.shields.io/discord/1064533716615049236.svg" alt="Discord Channel"></a>
+</div>
+
+----------
+
+## 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.
+</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="https://pepy.tech/projects/reserver">
+                <img src="https://static.pepy.tech/badge/reserver" alt="PyPI Downloads">
+            </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/actions/workflows/test.yml/badge.svg?branch=main">
+        </td>
+        <td align="center">
+            <img src="https://github.com/openscilab/reserver/actions/workflows/test.yml/badge.svg?branch=dev">
+            </td>
+    </tr>
+</table>
+
+
+## Installation
+
+### PyPI
+
+- Check [Python Packaging User Guide](https://packaging.python.org/installing/)
+- Run `pip install reserver==0.3`
+### Source code
+- Download [Version 0.3](https://github.com/openscilab/reserver/archive/v0.3.zip) or [Latest Source](https://github.com/openscilab/reserver/archive/dev.zip)
+- Run `pip install .`
+
+## Usage
+
+### Programmatically 
+Reserve a package name in main PyPI (pypi.org)
+```python
+from reserver import PyPIUploader
+uploader = PyPIUploader(PYPI_TOKEN, test_pypi=False)
+uploader.upload("CONSIDERED_NAME_FOR_YOUR_PACKAGE")
+```
+Reserve batch of names with custom user-defined parameters in test PyPI (test.pypi.org)
+```python
+uploader = PyPIUploader(TEST_PYPI_TOKEN, test_pypi=True)
+uploader.batch_upload(["PACKAGE_NAME_1", "PACKAGE_NAME_2"], ["config1.json", "config2.json"])
+```
+### CLI
+ℹ️ You can use `reserver` or `python -m reserver` to run this program
+#### Version
+```console
+reserver -v
+reserver --version
+```
+#### Reserve in test PyPI (test.pypi.org)
+```console
+reserver --name sample_name1 sample_name2 --token=TEST_PYPI_TOKEN --test
+```
+#### Reserve in main PyPI (pypi.org)
+```console
+reserver --name sample_name1 sample_name2 --token=PYPI_TOKEN
+```
+#### Customizing package parameters
+
+You can customize the following package parameters for reservations on PyPI using the Reserver CLI. The details and defaults are provided in the table below.
+
+| Parameter | Type | Default | Description |
+|---|---|---|---|
+| `description` | string | `This name has been reserved using Reserver` | A short description of your PyPI package name reservation. |
+| `author` | string | `Development Team` | The name of the author or development team. |
+| `author_email` | email address | `test@test.com` | An email address for contact. |
+| `url` | web address | `https://url.com` | The project's main repository URL. |
+| `download_url` | web address | `https://download_url.com` | The download URL for the package. |
+| `source` | web address | `https://github.com/source` | The source code repository URL. |
+| `license` | string | `MIT` | The license under which your package is distributed. |
+
+There are two ways to define these custom parameters:
+
+**1. Single `param.json` for all packages:**
+
+This 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.
+
+Here's how to use this method:
+
+```console
+reserver --name sample_name1 sample_name2 --param config.json --token=PYPI_TOKEN
+```
+**2. Dedicated `param.json` per package:**
+
+This approach allows for more customization by having a separate JSON file for each package. Each file would contain parameters specific to that particular package.
+
+Here's how this method works:
+
+```console
+reserver --name sample_name1 sample_name2 --param name1_param.json name2_param.json --token=PYPI_TOKEN
+```
+
+Choose 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.
+
+ℹ️ You can use all available features on both `pypi.org` and `test.pypi.org`.
+## Issues & bug reports
+
+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
+ 
+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>

v2kit-0.0.0/setup.cfg

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

v2kit-0.0.0/setup.py

@@ -0,0 +1,73 @@
+# -*- 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.3',
+    description='PyPI package name reserver',
+    long_description=read_description(),
+    long_description_content_type='text/markdown',
+    author='Reserver Development Team',
+    author_email='reserver@openscilab.com',
+    url='https://github.com/openscilab/reserver',
+    download_url='https://github.com/openscilab/reserver/tarball/v0.3',
+    keywords="pypi pip package name reserve reserver reservation python",
+    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',
+        'Programming Language :: Python :: 3.13',
+        'Intended Audience :: Developers',
+        'Intended Audience :: Education',
+        'Intended Audience :: End Users/Desktop',
+        'Intended Audience :: Manufacturing',
+        'Intended Audience :: Science/Research',
+
+    ],
+    license='MIT',
+    entry_points={
+            'console_scripts': [
+                'reserver = reserver.__main__:main',
+            ]
+    }
+)

v2kit-0.0.0/tests/test_reserver.py

@@ -0,0 +1,47 @@
+import os
+from reserver import PyPIUploader
+from reserver.reserver_func import get_random_name
+
+pypi_token = os.environ.get("TWINE_PASSWORD")
+test_pypi_token = os.environ.get("TWINE_TEST_PASSWORD")
+
+def test_package_exists():
+    # test reserved name
+    uploader = PyPIUploader(test_pypi_token, test_pypi=True)
+    assert uploader.upload("numpy") == False
+
+def test_standard_module_conflict():
+    # try to reserve a standard python library module
+    uploader = PyPIUploader(test_pypi_token, test_pypi=True)
+    assert uploader.upload("os") == False
+
+def test_valid_package_invalid_credentials():
+    # test not reserved name -> wrong credentials
+    uploader = PyPIUploader("pypi-wrong-api-token", test_pypi=True)
+    assert uploader.upload(get_random_name()) == False
+
+def test_valid_package_valid_credentials():
+    # test not reserved name -> correct credentials
+    # uploader = PyPIUploader(test_pypi_token, test_pypi=True)
+    # assert uploader.upload(get_random_name()) == True
+    assert True == True
+
+def test_module_conflict():
+    # try to reserve a name which conflicts with the module name of a previously taken package (the taken package itself has a different name, but it's module name has conflict)."
+    uploader = PyPIUploader(test_pypi_token, test_pypi=True)
+    assert uploader.upload("freeze") == False
+
+def test_batch_packages_names():
+    # test batch of package names
+    uploader = PyPIUploader(test_pypi_token, test_pypi=True)
+    assert uploader.batch_upload(["numpy", "scikit-learn"]) == 0
+
+def test_batch_upload():
+    # try to reserve two non taken package names with per package custom setup.py parameters
+    # make sure you are in "tests" directory
+    # uploader = PyPIUploader(test_pypi_token, test_pypi=True)
+    # assert uploader.batch_upload(
+    #     [get_random_name(), get_random_name() + get_random_name()],
+    #     ["config.json", "config2.json"]
+    #     ) == 2
+    assert True == True

v2kit-0.0.0/v2kit/__init__.py

@@ -0,0 +1,2 @@
+# -*- coding: utf-8 -*-
+"""v2kit modules."""

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

@@ -0,0 +1,25 @@
+Metadata-Version: 2.1
+Name: v2kit
+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).

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

@@ -0,0 +1,11 @@
+AUTHORS.md
+LICENSE
+README.md
+setup.py
+v2kit_setup.py
+tests/test_reserver.py
+v2kit/__init__.py
+v2kit.egg-info/PKG-INFO
+v2kit.egg-info/SOURCES.txt
+v2kit.egg-info/dependency_links.txt
+v2kit.egg-info/top_level.txt

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

@@ -0,0 +1 @@
+

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

@@ -0,0 +1 @@
+v2kit

v2kit-0.0.0/v2kit_setup.py

@@ -0,0 +1,43 @@
+
+import sys
+
+try:
+    from setuptools import setup
+except ImportError:
+    from distutils.core import setup
+
+# invalid email
+# download url
+# url
+# project urls
+
+setup(
+    name ="v2kit",
+    packages=["v2kit",],
+    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",
+)
+