netlistx 0.1__tar.gz → 0.2__tar.gz

netlistx-0.2/GEMINI.md

@@ -0,0 +1,80 @@
+# GEMINI.md
+
+## Project Overview
+
+This project is a Python library named `netlistx`. Its purpose is to provide tools for working with netlists, which are representations of electronic circuits. The library defines classes and functions for creating, manipulating, and analyzing netlists, leveraging graph theory concepts and the `networkx` library.
+
+The core of the library is the `Netlist` class, which represents a circuit as a graph of modules (components) and nets (wires). It also includes various algorithms for solving graph problems, such as finding minimum covers for edges and cycles.
+
+The project is structured as a standard Python package using `pyscaffold`.
+
+## Building and Running
+
+### Dependencies
+
+The main dependencies are `networkx` and `mywheel` (a custom library from a git repository). Development and testing dependencies include `pytest`, `flake8`, `black`, `isort`, and `tox`.
+
+### Building the Package
+
+To build the source and wheel distributions:
+
+```bash
+tox -e build
+```
+
+The artifacts will be placed in the `dist/` directory.
+
+### Running Tests
+
+The project uses `pytest` for testing and `tox` to automate the process. To run the test suite:
+
+```bash
+tox
+```
+
+or simply:
+
+```bash
+pytest
+```
+
+### Linting
+
+The project uses `flake8` for linting. The CI pipeline runs the following command:
+
+```bash
+flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+```
+
+## Development Conventions
+
+The project follows standard Python development conventions and uses several tools to enforce code quality and style.
+
+### Code Style
+
+*   **Formatting:** `black` is used for code formatting.
+*   **Import Sorting:** `isort` is used to organize imports.
+*   **Linting:** `flake8` is used to check for style and quality issues.
+
+These checks are automated using `pre-commit` hooks, which are configured in `.pre-commit-config.yaml`. Contributors are expected to install and use these hooks.
+
+### Contribution Guidelines
+
+Detailed contribution guidelines are provided in `CONTRIBUTING.md`. The workflow involves:
+
+1.  Forking the repository.
+2.  Creating a feature branch.
+3.  Installing dependencies and `pre-commit` hooks.
+4.  Making changes, including adding tests and documentation.
+5.  Running tests with `tox`.
+6.  Submitting a pull request.
+
+### Documentation
+
+The documentation is built using `Sphinx` and can be generated by running:
+
+```bash
+tox -e docs
+```
+
+The output will be in `docs/_build/html`.

{netlistx-0.1/src/netlistx.egg-info → netlistx-0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: netlistx
-Version: 0.1
+Version: 0.2
 Summary: Ellipsoid Method in Python
 Home-page: https://github.com/pyscaffold/pyscaffold/
 Author: Wai-Shing Luk

{netlistx-0.1 → netlistx-0.2}/src/netlistx/graph_algo.py

@@ -75,7 +75,7 @@ def min_vertex_cover_fast(
 
         b     c     d     e
         #-----o-----#-----o
-        |      \   / \ 
+        |      \   / \
         |       \ /   \
         o        #-----o
         a        e     f

{netlistx-0.1 → netlistx-0.2}/src/netlistx/netlist.py

@@ -31,18 +31,6 @@ from networkx.algorithms import bipartite
 from networkx.readwrite import json_graph
 
 
-# The `ThinGraph` class is a subclass of `nx.Graph` that defines default attributes for edges and
-# nodes.
-class ThinGraph(nx.Graph):
-    all_edge_dict = {"weight": 1}
-
-    def single_edge_dict(self):
-        return self.all_edge_dict
-
-    edge_attr_dict_factory = single_edge_dict
-    node_attr_dict_factory = single_edge_dict
-
-
 # The class SimpleGraph is a subclass of nx.Graph and defines default attributes for edges and nodes.
 class SimpleGraph(nx.Graph):
     all_edge_dict = {"weight": 1}
@@ -227,7 +215,7 @@ def read_json(filename):
 
 
 def create_inverter():
-    gr = ThinGraph()
+    gr = SimpleGraph()
     gr.add_nodes_from(["a0", "p1", "p2", "n0", "n1"])
     nets = ["n0", "n1"]
     modules = ["a0", "p1", "p2"]
@@ -252,7 +240,7 @@ def create_inverter():
 
 
 def create_inverter2():
-    gr = ThinGraph()
+    gr = SimpleGraph()
     gr.add_nodes_from([0, 1, 2, 3, 4])
     nets = range(3, 5)
     modules = range(3)
@@ -280,10 +268,10 @@ def create_drawf():
     """
     The function `create_drawf` creates a graph and netlist object with specified nodes, edges, and
     weights.
-    :return: an instance of the Netlist class, which is created using the ThinGraph class and some
+    :return: an instance of the Netlist class, which is created using the SimpleGraph class and some
         predefined modules and nets.
     """
-    ugraph = ThinGraph()
+    ugraph = SimpleGraph()
     ugraph.add_nodes_from(
         [
             "a0",
@@ -349,7 +337,7 @@ def create_test_netlist():
     weights.
     :return: an instance of the `Netlist` class, which represents a netlist with modules and nets.
     """
-    ugraph = ThinGraph()
+    ugraph = SimpleGraph()
     ugraph.add_nodes_from(["a0", "a1", "a2", "a3", "a4", "a5"])
     # module_weight = [533, 543, 532]
     module_weight = {"a0": 533, "a1": 543, "a2": 532}

{netlistx-0.1 → netlistx-0.2/src/netlistx.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: netlistx
-Version: 0.1
+Version: 0.2
 Summary: Ellipsoid Method in Python
 Home-page: https://github.com/pyscaffold/pyscaffold/
 Author: Wai-Shing Luk

{netlistx-0.1 → netlistx-0.2}/src/netlistx.egg-info/SOURCES.txt

@@ -8,6 +8,7 @@
 AUTHORS.md
 CHANGELOG.md
 CONTRIBUTING.md
+GEMINI.md
 LICENSE
 LICENSE.txt
 README.md

{netlistx-0.1 → netlistx-0.2}/tox.ini

@@ -18,6 +18,7 @@ passenv =
 extras =
     testing
 commands =
+    pip install git+https://github.com/luk036/mywheel.git
     pytest {posargs}
 
 

{netlistx-0.1 → netlistx-0.2}/tests/test_netlist.py

@@ -3,8 +3,8 @@ import json
 from networkx.readwrite import json_graph
 
 from netlistx.netlist import (
-    create_inverter,
     create_drawf,
+    create_inverter,
     create_random_hgraph,
     create_test_netlist,
     read_json,