Rename project to pypickup

README.md

@@ -1,4 +1,4 @@
-# PyPI-cache utility
+# pypickup
 
 An utility to download packages from PyPI and save them locally, building a tree as if it were the PyPI repository itself.
 
@@ -20,33 +20,33 @@ pip install --editable .
 An -h flag can be used on any command to display all the available options and its usage. For instance:
 
 ```
-pypi-cache add -h
+pypickup add -h
 ```
 
 To add a package for the first time:
 
 ```
-pypi-cache add numpy
+pypickup add numpy
 ```
 
-This will create a folder in the default location (~/.pypi-cache/) in which all the stablished files (.whl and .zip) for the specified package will be downloaded. Besides, it will create the corresponding metadata files (index.html) to track that package. The next time you want to synchronize the same package against the PyPI remote repository, you should do:
+This will create a folder in the default location (~/.pypickup/) in which all the stablished files (.whl and .zip) for the specified package will be downloaded. Besides, it will create the corresponding metadata files (index.html) to track that package. The next time you want to synchronize the same package against the PyPI remote repository, you should do:
 
 ```
-pypi-cache update numpy
+pypickup update numpy
 ```
 
 This will download the new packages available in the remote, in case there is any. It'll do nothing otherwise. It also updates the index.html of the indicated package with the new downloaded packages, as expected.
 
 2 more commands are available to remove packages and to list the available ones already added:
 
 ```
-pypi-cache rm numpy
+pypickup rm numpy
 
-pypi-cache list
+pypickup list
 ```
 
 If we specify a package for the 'list' command, it will show a list of the downloaded distributions themselves.
 
 ```
-pypi-cache list numpy
+pypickup list numpy
 ```

pypickup/__main__.py

@@ -0,0 +1,3 @@
+from pypickup.cli import cli
+
+cli()

pypi_cache/cli.py → pypickup/cli.py

@@ -3,9 +3,9 @@
 
 
 def cli():
-    entrypoints = entry_points()["pypi_cache.cmd"]
+    entrypoints = entry_points()["pypickup.cmd"]
 
-    parser = argparse.ArgumentParser(prog="pypi-cache", description="Manage a local offline PyPi mirror")
+    parser = argparse.ArgumentParser(prog="pypickup", description="Manage a local offline PyPi mirror")
     subparsers = parser.add_subparsers(help="available commands", dest="cmd")
 
     plugins = {}

pypi_cache/cmd/add.py → pypickup/cmd/add.py

@@ -3,14 +3,14 @@
 
 from typing import List
 
-from pypi_cache.pypiCacheManager import LocalPyPIController
+from pypickup.controller import LocalPyPIController
 
 
 class Add:
     @staticmethod
     def init_subparser(parser: argparse.ArgumentParser):
-        parser.add_argument("packageNameList", type=str, nargs='+', default="", help="Python packages list to add to the local repository.")
-        parser.add_argument("-p", "--index-path", dest="pypiLocalPath", type=str, default=os.getenv('PYPICACHE_INDEX_PATH', default="./.pypi-cache/"), help="Local root path in which the package from the PyPI repository will be downloaded.")
+        parser.add_argument("packageNameList", type=str, nargs="+", default="", help="Python packages list to add to the local repository.")
+        parser.add_argument("-p", "--index-path", dest="pypiLocalPath", type=str, default=os.getenv("PYPICACHE_INDEX_PATH", default="./.pypickup/"), help="Local root path in which the package from the PyPI repository will be downloaded.")
 
         parser.add_argument("-s", "--only-src", dest="onlySources", default=False, action="store_true", help="Download only the source files (.zip and .tar.gz). Disabled by default.")
         parser.add_argument("--dev", dest="includeDevs", default=False, action="store_true", help="Download also the new development releases (alpha, betas), which are not included by default.")
@@ -21,13 +21,13 @@ def init_subparser(parser: argparse.ArgumentParser):
     def run(args: argparse.Namespace):
         listOfPackages: List[str] = args.packageNameList
         for packageName in listOfPackages:
-            
+
             args.packageName = packageName
             print("Adding '" + packageName + "' to the local index:")
 
             controllerInstance = LocalPyPIController()
             controllerInstance.parseScriptArguments(args)
-            
+
             if controllerInstance.validPackageName():
                 controllerInstance.initLocalRepo()
 
@@ -38,5 +38,5 @@ def run(args: argparse.Namespace):
                     print("Package " + controllerInstance.packageName + " has been already added to the local repository. Try to run the 'update' command instead to synchronize changes with the remote PyPI.")
             else:
                 print("Package " + controllerInstance.packageName + " does not exist in the remote repository (" + controllerInstance.remotePyPIRepository + ")")
-            
+
             print()

pypi_cache/cmd/remove.py → pypickup/cmd/remove.py

@@ -3,14 +3,14 @@
 
 from typing import List
 
-from pypi_cache.pypiCacheManager import LocalPyPIController
+from pypickup.controller import LocalPyPIController
 
 
 class Remove:
     @staticmethod
     def init_subparser(parser: argparse.ArgumentParser):
         parser.add_argument("packageNameList", type=str, nargs="+", default="", help="Python packages list to be removed from the local repository.")
-        parser.add_argument("-p", "--index-path", dest="pypiLocalPath", type=str, default=os.getenv("PYPICACHE_INDEX_PATH", default="./.pypi-cache/"), help="Local root path in which the specified package is expected to be.")
+        parser.add_argument("-p", "--index-path", dest="pypiLocalPath", type=str, default=os.getenv("PYPICACHE_INDEX_PATH", default="./.pypickup/"), help="Local root path in which the specified package is expected to be.")
 
     @staticmethod
     def __fillUpNonUsedArguments(args: argparse.Namespace) -> argparse.Namespace:

pypi_cache/cmd/update.py → pypickup/cmd/update.py

@@ -3,14 +3,14 @@
 
 from typing import List
 
-from pypi_cache.pypiCacheManager import LocalPyPIController
+from pypickup.controller import LocalPyPIController
 
 
 class Update:
     @staticmethod
     def init_subparser(parser: argparse.ArgumentParser):
-        parser.add_argument("packageNameList", type=str, nargs='+', default="", help="Python packages list to add to the local repository.")
-        parser.add_argument("-p", "--index-path", dest="pypiLocalPath", type=str, default=os.getenv('PYPICACHE_INDEX_PATH', default="./.pypi-cache/"), help="Local root path in which the package from the PyPI repository will be synchronized.")
+        parser.add_argument("packageNameList", type=str, nargs="+", default="", help="Python packages list to add to the local repository.")
+        parser.add_argument("-p", "--index-path", dest="pypiLocalPath", type=str, default=os.getenv("PYPICACHE_INDEX_PATH", default="./.pypickup/"), help="Local root path in which the package from the PyPI repository will be synchronized.")
 
         parser.add_argument("-s", "--only-src", dest="onlySources", default=False, action="store_true", help="Download only the source files (.zip and .tar.gz). Disabled by default.")
         parser.add_argument("--dev", dest="includeDevs", default=False, action="store_true", help="Download also the new development releases (alpha, betas), which are not included by default.")
@@ -21,10 +21,10 @@ def init_subparser(parser: argparse.ArgumentParser):
     def run(args: argparse.Namespace):
         listOfPackages: List[str] = args.packageNameList
         for packageName in listOfPackages:
-            
+
             args.packageName = packageName
             print("Updating the local index for '" + packageName + "':")
-            
+
             controllerInstance = LocalPyPIController()
             controllerInstance.parseScriptArguments(args)
 
@@ -33,5 +33,5 @@ def run(args: argparse.Namespace):
                 controllerInstance.synchronizeWithRemote()
             else:
                 print("Package " + controllerInstance.packageName + " has not been added to the local repository yet. Run the 'add' command first.")
-            
+
             print()

pypi_cache/pypiCacheManager.py → pypickup/controller.py

@@ -8,7 +8,7 @@
 
 import requests
 
-from pypi_cache.utils.htmlManager import HTMLManager
+from pypickup.utils.htmlManager import HTMLManager
 
 
 class LocalPyPIController:
@@ -150,7 +150,7 @@ def __getLink(self, linkURL: str, verbose: bool = True, retries: int = 10, timeB
                 if verbose: 
                     print("Trying again...\t(" + linkURL + ")")
                 time.sleep(timeBetweenRetries)
-        
+
         if response.status_code != 200:
             if retries > 1 and verbose:
                 print("Last try on...\t(" + linkURL + ")")

pypi_cache/settings/wheelFilters.py → pypickup/settings/wheelFilters.py

@@ -3,19 +3,9 @@
 inOrOut_wheels = "out"
 
 # ToDo: "(python_tags>=1.2 | python_tags==1.01) & version>=18.0 & #^cp\d*d-\d*.whl$ | #^cp\d*d-manylinux14.whl$"
-inFilters_wheels = {
-    "version": [],
-    "python_tags": [">=3.5"],
-    "abi_tags": ["~cp36", "~cp37"],
-    "platform_tags": ["~manylinux", "~win32", "~amd64"]
-}
-
-outFilters_wheels = {
-    "version": ["~rc"],
-    "python_tags": ["~pp", "~cp2", "<3.5"],
-    "abi_tags": ["~mu"],
-    "platform_tags": ["~i686", "~win32"]
-}
+inFilters_wheels = {"version": [], "python_tags": [">=3.5"], "abi_tags": ["~cp36", "~cp37"], "platform_tags": ["~manylinux", "~win32", "~amd64"]}
+
+outFilters_wheels = {"version": ["~rc"], "python_tags": ["~pp", "~cp2", "<3.5"], "abi_tags": ["~mu"], "platform_tags": ["~i686", "~win32"]}
 
 # Attributes lists (https://peps.python.org/pep-0425/):
 # version: rc[X]
@@ -27,10 +17,11 @@
 
 from typing import Dict, List
 
+
 class WheelsConfig:
 
     """
-    A class to save the configuration for the PyPI-cache commands.
+    A class to save the configuration for the pypickup commands.
 
     The user can choose between filtering wheels in or out. If self.inOrOut == "in", the expected logic is that all packages will not be considere by
     default, only if they match with the specified expressions. If self.inOurOut == "out", then all the packages will be included by default and only

pypi_cache/utils/htmlManager.py → pypickup/utils/htmlManager.py

@@ -10,7 +10,7 @@
 import wheel_filename
 from multimethod import multimethod
 
-from pypi_cache.settings.wheelFilters import WheelsConfig
+from pypickup.settings.wheelFilters import WheelsConfig
 
 
 class WheelsManager:

pyproject.toml

@@ -3,7 +3,7 @@ requires = ["setuptools>=61.0"]
 build-backend = "setuptools.build_meta"
 
 [project]
-name = "pypi-cache"
+name = "pypickup"
 version = "0.1.0"
 authors = [
   { name="German Navarro", email="ge.najim@gmail.com" },
@@ -27,18 +27,18 @@ dependencies = [
 ]
 
 [tool.setuptools]
-packages = ["pypi_cache", "pypi_cache.cmd", "pypi_cache.settings", "pypi_cache.utils"]
+packages = ["pypickup", "pypickup.cmd", "pypickup.settings", "pypickup.utils"]
 
 [project.urls]
-"Homepage" = "https://github.com/UB-Quantic/pypi-cache"
+"Homepage" = "https://github.com/UB-Quantic/pypickup"
 
 [project.scripts]
-pypi-cache = "pypi_cache.cli:cli"
+pypickup = "pypickup.cli:cli"
 
-[project.entry-points."pypi_cache.cmd"]
-add = "pypi_cache.cmd:Add"
-update = "pypi_cache.cmd:Update"
-rm = "pypi_cache.cmd:Remove"
+[project.entry-points."pypickup.cmd"]
+add = "pypickup.cmd:Add"
+update = "pypickup.cmd:Update"
+rm = "pypickup.cmd:Remove"
 
 [tool.black]
 line-length = 1000