renamed everything because pypacer was already taken

Author: 73h

README.md

@@ -1,6 +1,6 @@
 # Generate auto proxy config files (PAC) from a declaration
 
-[![Tests](https://github.com/73h/pypacer/actions/workflows/tests.yml/badge.svg)](https://github.com/73h/pypacer/actions/workflows/tests.yml)
+[![Tests](https://github.com/73h/paccreator/actions/workflows/tests.yml/badge.svg)](https://github.com/73h/paccreator/actions/workflows/tests.yml)
 
 ---
 
@@ -12,12 +12,12 @@ subtleties. If you have unusual requirements, it is better to write the proxy sc
 
 You can install the package with pip.
 ```
-pip install pypacer <-- not yet available
+pip install paccreator
 ```
 
 You can also load the script directly from github with pip.
 ```
-pip install git+https://github.com/73h/pypacer.git@main#egg=pypacer
+pip install git+https://github.com/73h/paccreator.git@main#egg=paccreator
 ```
 
 Create a file called myproxy.yaml and define your proxy rules in it like this.
@@ -43,14 +43,24 @@ proxies:
 Run this in python.  
 ```python
 import os
-from pypacer import PyPacer
+from paccreator import PacCreator
 
-p = PyPacer()
+p = PacCreator()
 with open(os.path.join("myproxy.yaml"), "r") as f:
     p.load_from_yaml(f.read())
     print(p.output())
 ```
 
+You can also use with contextmanager.
+```python
+import os
+from paccreator import load_from_yaml
+
+with open(os.path.join("myproxy.yaml"), "r") as f:
+    with load_from_yaml(f.read()) as p:
+        print(p.output())
+```
+
 ## Examples
 
 ### A simple Example for a random company

bin/run_tests_in_docker.sh

@@ -2,4 +2,4 @@
 
 cd $(dirname "$0")/..
 
-docker compose run --rm pypacer watching_testrunner -- pytest --disable-warnings --tb=short $@
+docker compose run --rm paccreator watching_testrunner -- pytest --disable-warnings --tb=short $@

docker-compose.yml

@@ -1,5 +1,5 @@
 services:
-  pypacer:
+  paccreator:
     restart: "no"
     build:
       context: .

pyproject.toml

@@ -3,7 +3,7 @@ requires = ["setuptools"]
 build-backend = "setuptools.build_meta"
 
 [project]
-name = "pypacer"
+name = "paccreator"
 version = "0.2.0"
 dynamic = ["dependencies"]
 authors = [
@@ -23,7 +23,7 @@ classifiers = [
     "Operating System :: OS Independent",
 ]
 [project.urls]
-Homepage = "https://github.com/73h/pypacer"
+Homepage = "https://github.com/73h/paccreator"
 
 [project.optional-dependencies]
 test = [

src/main.py

@@ -1,4 +1,4 @@
-from pypacer import load_from_yaml
+from paccreator import load_from_yaml
 
 if __name__ == "__main__":
     simple_proxy = """

src/paccreator/__init__.py

@@ -0,0 +1,10 @@
+from paccreator.paccreator import load_from_yaml, load_from_dict
+from .helpers import TargetType
+from .paccreator import PacCreator
+
+__all__ = [
+    "PacCreator",
+    "load_from_yaml",
+    "load_from_dict",
+    "TargetType",
+]

src/pypacer/helpers.py renamed to src/paccreator/helpers.py

@@ -7,15 +7,15 @@
 from jinja2 import Environment, FileSystemLoader
 
 from .helpers import sort_by_rating
-from .pypacerconfig import PyPacerConfig
+from .paccreatorconfig import PacCreatorConfig
 
 
-class PyPacer:
+class PacCreator:
     def __init__(self):
-        self.config: Optional[PyPacerConfig] = None
+        self.config: Optional[PacCreatorConfig] = None
 
     def load_from_dict(self, config: dict):
-        self.config = PyPacerConfig(**config)
+        self.config = PacCreatorConfig(**config)
         self.config.validate()
 
     def load_from_yaml(self, config: str):
@@ -78,14 +78,14 @@ def output(self, excludes: list[str] = None, includes: list[str] = None) -> str:
 
 
 @contextmanager
-def load_from_yaml(config: str) -> PyPacer():
-    p = PyPacer()
+def load_from_yaml(config: str) -> PacCreator():
+    p = PacCreator()
     p.load_from_yaml(config)
     yield p
 
 
 @contextmanager
-def load_from_dict(config: dict) -> PyPacer():
-    p = PyPacer()
+def load_from_dict(config: dict) -> PacCreator():
+    p = PacCreator()
     p.load_from_dict(config)
     yield p

src/pypacer/pypacer.py renamed to src/paccreator/paccreator.py

@@ -1,7 +1,7 @@
 import ipaddress
 from dataclasses import dataclass, field
 
-from pypacer.helpers import get_target_type, TargetType
+from paccreator.helpers import get_target_type, TargetType
 
 
 class Target:
@@ -42,7 +42,7 @@ def __post_init__(self):
 
 
 @dataclass
-class PyPacerConfig:
+class PacCreatorConfig:
     proxies: list
     version: str = "0.1"
     description: str = "pac file for my company"

src/pypacer/pypacerconfig.py renamed to src/paccreator/paccreatorconfig.py

@@ -1,8 +1,8 @@
 import unittest
 
-from pypacer.helpers import get_target_type, sort_by_rating, is_ipaddress, is_network, \
+from paccreator.helpers import get_target_type, sort_by_rating, is_ipaddress, is_network, \
     is_hostname, TargetType
-from pypacer.pypacerconfig import PyPacerConfig
+from paccreator.paccreatorconfig import PacCreatorConfig
 
 
 class TestHelpers(unittest.TestCase):
@@ -54,7 +54,7 @@ def test_is_hostname(self):
     def test_sort_by_rating(self):
         config = {"proxies": [{"route": "A", "tags": ["default"], "targets": [".example.com"]},
                               {"route": "B", "targets": ["foo.example.com"]}]}
-        config = PyPacerConfig(**config)
+        config = PacCreatorConfig(**config)
         config.recognize_overlaps()
         self.assertEqual(config.proxies[0].route, "A")
         self.assertEqual(config.proxies[1].targets[0].rating, 1)

src/pypacer/template.js.jinja renamed to src/paccreator/template.js.jinja

@@ -4,53 +4,53 @@
 
 from pypac.parser import PACFile
 
-from pypacer import PyPacer
-from pypacer.pypacerconfig import PyPacerConfig
+from paccreator import PacCreator
+from paccreator.paccreatorconfig import PacCreatorConfig
 
 location = pathlib.Path(__file__).parent.resolve()
 
 
-class TestPyPacer(unittest.TestCase):
+class TestPacCreator(unittest.TestCase):
 
     def setUp(self):
         self.pac_file = open(os.path.join(location, "..", "examples", "unittests.yaml"), "r").read()
 
     def test_load_config_from_yaml(self):
-        p = PyPacer()
+        p = PacCreator()
         p.load_from_yaml(self.pac_file)
-        self.assertIsInstance(p.config, PyPacerConfig)
+        self.assertIsInstance(p.config, PacCreatorConfig)
         self.assertEqual(p.config.proxies[0].route, "DIRECT")
         output = p.output()
         open(os.path.join(location, "..", "examples", "unittests.pac"), "w").write(output)
 
     def test_exclude_by_tag(self):
-        p = PyPacer()
+        p = PacCreator()
         p.load_from_yaml(self.pac_file)
         output = p.output(excludes=["foo"])
         self.assertTrue("PROXY netmask.example.com" not in output)
 
     def test_exclude_by_tags(self):
-        p = PyPacer()
+        p = PacCreator()
         p.load_from_yaml(self.pac_file)
         output = p.output(excludes=["foo", "default"])
         self.assertTrue("PROXY netmask.example.com" not in output)
         self.assertTrue("PROXY default.example.com" not in output)
 
     def test_include_by_tag(self):
-        p = PyPacer()
+        p = PacCreator()
         p.load_from_yaml(self.pac_file)
         output = p.output(includes=["foo"])
         self.assertTrue("PROXY netmask.example.com" in output)
 
     def test_include_by_tags(self):
-        p = PyPacer()
+        p = PacCreator()
         p.load_from_yaml(self.pac_file)
         output = p.output(includes=["foo", "default"])
         self.assertTrue("PROXY netmask.example.com" in output)
         self.assertTrue("PROXY default.example.com" in output)
 
     def test_output(self):
-        p = PyPacer()
+        p = PacCreator()
         p.load_from_yaml(self.pac_file)
         pac_file = PACFile(p.output())
         self.assertEqual(pac_file.find_proxy_for_url("", "foo.bar"), "PROXY default.example.com")

src/pypacer/__init__.py

@@ -1,27 +1,27 @@
 import unittest
 
-from pypacer.pypacerconfig import PyPacerConfig
+from paccreator.paccreatorconfig import PacCreatorConfig
 
 
-class TestPyPacerConfig(unittest.TestCase):
+class TestPacCreatorConfig(unittest.TestCase):
 
     def test_proxy_has_no_route(self):
         config = {"proxies": [{"route": ""}]}
-        config = PyPacerConfig(**config)
+        config = PacCreatorConfig(**config)
         with self.assertRaises(ValueError) as err:
             config.validate()
         self.assertEqual(str(err.exception), "one proxy has no route")
 
     def test_get_default_proxy_route(self):
         config = {"proxies": [{"route": "foo"}, {"route": "bar", "tags": ["default"]}]}
-        config = PyPacerConfig(**config)
+        config = PacCreatorConfig(**config)
         self.assertEqual(config.get_default_proxy().route, "bar")
 
     def test_get_default_proxy_route_with_no_default_proxy(self):
         config = {"proxies": [{"route": "foo"}, {"route": "bar"}]}
-        config = PyPacerConfig(**config)
+        config = PacCreatorConfig(**config)
         self.assertEqual(config.get_default_proxy().route, "foo")
 
     def test_target_is_string(self):
         config = {"proxies": [{"route": "foo", "targets": [10., "foo"]}]}
-        PyPacerConfig(**config)
+        PacCreatorConfig(**config)