From 4005f47b8192f7d8cac1c746a13eccebba69b1b1 Mon Sep 17 00:00:00 2001 From: Enji Cooper Date: Sat, 21 Mar 2026 22:25:28 -0700 Subject: [PATCH 1/2] Add `.gitignore` This prevents files generated by pip, et al, from being checked in to the tree by accident. This is based on the GitHub canned `.gitignore` file for python projects. Signed-off-by: Enji Cooper --- .gitignore | 177 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 177 insertions(+) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..4686de1 --- /dev/null +++ b/.gitignore @@ -0,0 +1,177 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# UV +# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +#uv.lock + +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +#poetry.lock + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +#pdm.lock +# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it +# in version control. +# https://pdm.fming.dev/latest/usage/project/#working-with-version-control +.pdm.toml +.pdm-python +.pdm-build/ + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# PyCharm +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +#.idea/ + +# Ruff stuff: +.ruff_cache/ + +# PyPI configuration file +.pypirc + +# notebook folder (used for further analysis on personal data) +/notebooks \ No newline at end of file From 02af0ec8d71ca012e75d2d82c43f860faa34be8c Mon Sep 17 00:00:00 2001 From: Enji Cooper Date: Sat, 21 Mar 2026 22:27:09 -0700 Subject: [PATCH 2/2] Modernize packaging method used by project - Replace `setup.py` use with `pyproject.toml`. - Add `tox` integration. - Move files under appropriate directories to match modern python project design structure. Signed-off-by: Enji Cooper --- MANIFEST.in | 1 - Makefile | 9 +- pyproject.toml | 112 ++++++++++++++++++++ setup.py | 36 ------- macaddress.py => src/macaddress/__init__.py | 0 test.py => tests/test_macaddress.py | 0 6 files changed, 115 insertions(+), 43 deletions(-) delete mode 100644 MANIFEST.in create mode 100644 pyproject.toml delete mode 100755 setup.py rename macaddress.py => src/macaddress/__init__.py (100%) rename test.py => tests/test_macaddress.py (100%) diff --git a/MANIFEST.in b/MANIFEST.in deleted file mode 100644 index 1aba38f..0000000 --- a/MANIFEST.in +++ /dev/null @@ -1 +0,0 @@ -include LICENSE diff --git a/Makefile b/Makefile index 3645537..090b8e6 100644 --- a/Makefile +++ b/Makefile @@ -1,9 +1,6 @@ -default: - python setup.py sdist bdist_wheel +all: clean: - rm -rf __pycache__ *.py[oc] build *.egg-info dist MANIFEST -test: - pytest test.py - PYTHONPATH=. pytest README.rst +check test: .PHONY + tox -c . diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..b3aee56 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,112 @@ +[build-system] +requires = ["setuptools>=65"] +build-backend = "setuptools.build_meta" + +[project] +name = "macaddress" +version = "2.0.2" +dependencies = [ +] +requires-python = ">=3.8" +authors = [ + { name = "Alexander Kozhevnikov", email = "mentalisttraceur@gmail.com" } +] +maintainers = [ + { name = "Alexander Kozhevnikov", email = "mentalisttraceur@gmail.com" } +] +description = "." +readme = "README.rst" +license-files = [ + "LICENSE" +] +keywords = ["network"] +classifiers = [ + "Development Status :: 5 - Production/Stable", + "Intended Audience :: Developers", + "Operating System :: OS Independent", + "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", + "Programming Language :: Python :: 3.14", + "Programming Language :: Python :: 3.15", + "Programming Language :: Python :: 3" +] + +[dependency-groups] +coverage = [ + "coverage", + "pytest-cov" +] +test = [ + "hypothesis", + "pytest>7", + "pytest-timeout", + "reprshed" +] +dev = [ + {include-group = "coverage"}, + {include-group = "test"}, +] + +[project.urls] +Repository = 'https://github.com/mentalisttraceur/python-macaddress' +Issues = 'https://github.com/mentalisttraceur/python-macaddress/issues' + +[tool.coverage.html] +directory = "htmlcov" + +[tool.coverage.run] +branch = true +source = ["src/"] + +[tool.pytest.ini_options] +timeout = 10 + +[tool.setuptools] +package-dir = {"" = "src/"} + +[tool.tox] +legacy_tox_ini = """ +[tox] +min_version = 4.0 +env_list = + coverage + doctest + py38 + py39 + py310 + py311 + py312 + py313 + py314 + py315 + +[testenv] +dependency_groups = + test +commands = + {envpython} -m pytest {posargs:-v tests} + +[testenv:coverage] +dependency_groups = + coverage + test +commands = + {envpython} -m pytest --cov=macaddress --cov-fail-under=80 --cov-report=html --cov-report=term \ + {posargs:-vvvv tests} + +[testenv:doctest] +dependency_groups = + test +commands = + {envpython} -m pytest {posargs:-v} README.rst + +[testenv:type] +deps = + mypy +commands = + {envpython} -m mypy {posargs:src} +""" diff --git a/setup.py b/setup.py deleted file mode 100755 index be98886..0000000 --- a/setup.py +++ /dev/null @@ -1,36 +0,0 @@ -#!/usr/bin/env python - -import os - -try: - from setuptools import setup -except ImportError: - from distutils.core import setup - -from macaddress import __doc__, __version__ - -project_directory = os.path.abspath(os.path.dirname(__file__)) -readme_path = os.path.join(project_directory, 'README.rst') - -readme_file = open(readme_path) -try: - long_description = readme_file.read() -finally: - readme_file.close() - -setup( - name='macaddress', - version=__version__, - description=__doc__.split('\n')[0], - long_description=long_description, - license='0BSD', - url='https://github.com/mentalisttraceur/python-macaddress', - author='Alexander Kozhevnikov', - author_email='mentalisttraceur@gmail.com', - classifiers=[ - 'Development Status :: 5 - Production/Stable', - 'Programming Language :: Python :: 3', - 'Operating System :: OS Independent', - ], - py_modules=['macaddress'], -) diff --git a/macaddress.py b/src/macaddress/__init__.py similarity index 100% rename from macaddress.py rename to src/macaddress/__init__.py diff --git a/test.py b/tests/test_macaddress.py similarity index 100% rename from test.py rename to tests/test_macaddress.py