From 5fe7f0df632b6af048618a4c366f263be07e11d3 Mon Sep 17 00:00:00 2001
From: Jacob Lifshay <programmerjake@gmail.com>
Date: Sun, 3 Apr 2022 22:22:12 -0700
Subject: [PATCH] setup python project structure

---
 .gitignore                                   | 12 +++++
 NEWS.txt                                     |  1 +
 README.md                                    |  1 +
 setup.py                                     | 47 ++++++++++++++++++++
 src/nmigen_gf/{hdl/.git-keep => __init__.py} |  0
 src/nmigen_gf/hdl/__init__.py                |  0
 src/nmigen_gf/reference                      |  1 +
 7 files changed, 62 insertions(+)
 create mode 100644 .gitignore
 create mode 100644 NEWS.txt
 create mode 100644 README.md
 create mode 100644 setup.py
 rename src/nmigen_gf/{hdl/.git-keep => __init__.py} (100%)
 create mode 100644 src/nmigen_gf/hdl/__init__.py
 create mode 120000 src/nmigen_gf/reference

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..9c0e8af
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,12 @@
+/dist
+/.vscode
+*.egg-info
+*.pyc
+*.il
+*.il.*
+*.vcd
+*.gtkw
+__pycache__
+.eggs
+/sim_test_out
+/formal_test_temp
\ No newline at end of file
diff --git a/NEWS.txt b/NEWS.txt
new file mode 100644
index 0000000..2fd9f95
--- /dev/null
+++ b/NEWS.txt
@@ -0,0 +1 @@
+TBD
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e82aca2
--- /dev/null
+++ b/README.md
@@ -0,0 +1 @@
+# Reference Python code and nMigen HDL for Carry-Less and Galois Field Operations
\ No newline at end of file
diff --git a/setup.py b/setup.py
new file mode 100644
index 0000000..47dfe6c
--- /dev/null
+++ b/setup.py
@@ -0,0 +1,47 @@
+from setuptools import setup, find_packages
+import os
+
+here = os.path.abspath(os.path.dirname(__file__))
+README = open(os.path.join(here, "README.md")).read()
+NEWS = open(os.path.join(here, "NEWS.txt")).read()
+
+version = "0.0.1"
+
+install_requires = [
+    # ok to install using pip3 as long as it is not with the rest of Libre-SOC.
+    # https://git.libre-soc.org/?p=nmigen.git
+    "nmigen",
+    # can be obtained with pip3, best done manually
+    # https://git.libre-soc.org/?p=nmutil.git
+    "libresoc-nmutil",
+]
+
+test_requires = [
+    "nose",
+]
+
+setup(
+    name="libresoc-nmigen-gf",
+    version=version,
+    description="Reference Python code and nMigen HDL for Carry-Less and Galois Field Operations",
+    long_description=README + "\n\n",
+    long_description_content_type="text/markdown",
+    classifiers=[
+        "Topic :: Software Development",
+        "License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)",
+        "Programming Language :: Python :: 3",
+        "Operating System :: OS Independent",
+    ],
+    keywords="nmigen libre-soc carry-less clmul gf2 galois-field galois gfp",
+    author="Jacob Lifshay",
+    author_email="programmerjake@gmail.com",
+    url="https://git.libre-soc.org/?p=nmigen-gf.git",
+    license="LGPLv3+",
+    packages=find_packages("src"),
+    package_dir={"": "src"},
+    include_package_data=True,
+    zip_safe=False,
+    install_requires=install_requires,
+    tests_require=test_requires,
+    test_suite="nose.collector"
+)
diff --git a/src/nmigen_gf/hdl/.git-keep b/src/nmigen_gf/__init__.py
similarity index 100%
rename from src/nmigen_gf/hdl/.git-keep
rename to src/nmigen_gf/__init__.py
diff --git a/src/nmigen_gf/hdl/__init__.py b/src/nmigen_gf/hdl/__init__.py
new file mode 100644
index 0000000..e69de29
diff --git a/src/nmigen_gf/reference b/src/nmigen_gf/reference
new file mode 120000
index 0000000..724e80f
--- /dev/null
+++ b/src/nmigen_gf/reference
@@ -0,0 +1 @@
+../../gf_reference/
\ No newline at end of file
-- 
2.30.2