diff --git a/dev_requirements.txt b/dev_requirements.txt
deleted file mode 100644
index a31d3ab1..00000000
--- a/dev_requirements.txt
+++ /dev/null
@@ -1,10 +0,0 @@
-# modules required for development only
-# $ pip install --requirement dev_requirements.txt
-
-setuptools # for plugins
-pyflakes
-pycodestyle
-pytest>=7.1.0
-coverage>=6.0
-doit-py>=0.4.0
-tomli; python_version<"3.11"
diff --git a/doc/conf.py b/doc/conf.py
index 24b039d5..2ad38c0e 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -46,6 +46,9 @@
'sphinx.ext.githubpages',
'sphinx_sitemap',
'sphinx_reredirects',
+ 'autoapi.extension',
+ 'autodocsumm',
+ 'sphinx.ext.napoleon'
]
# Add any paths that contain templates here, relative to this directory.
@@ -65,7 +68,7 @@
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
@@ -75,6 +78,26 @@
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = None
+# [Autoapi](https://sphinx-autoapi.readthedocs.io/) config
+autodoc_typehints = 'description'
+
+autodoc_default_options = {
+ 'autosummary': True,
+}
+
+autoapi_dirs = ["../doit"]
+autoapi_options = [
+ 'members',
+ 'undoc-members',
+ 'show-inheritance',
+ 'show-module-summary',
+ 'imported-members',
+]
+
+autoapi_keep_files = True
+
+# -- Options for HTML output -------------------------------------------------
+
# non-default configuration for doit
html_favicon = '_static/favico.ico'
html_show_sourcelink = False
@@ -82,8 +105,6 @@
html_logo = '_static/doit-logo-small.png'
-# -- Options for HTML output -------------------------------------------------
-
html_baseurl = 'https://pydoit.org'
# The theme to use for HTML and HTML Help pages. See the documentation for
diff --git a/doc/contents.rst b/doc/contents.rst
index bb0f7b70..f60824eb 100644
--- a/doc/contents.rst
+++ b/doc/contents.rst
@@ -66,6 +66,13 @@ Project
related
+API Reference
+-------------
+
+.. toctree::
+ :maxdepth: 2
+
+ autoapi/index
.. Indices and tables
==================
diff --git a/doc/index.html b/doc/index.html
index b2838f37..3d50784d 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -49,9 +49,9 @@
Toggle navigation to the black list. It should be a base name, not a
-# path. You may set this option multiple times.
-ignore=CVS
-
-# Pickle collected data for later comparisons.
-persistent=yes
-
-# List of plugins (as comma separated values of python modules names) to load,
-# usually to register additional checkers.
-load-plugins=
-
-
-[MESSAGES CONTROL]
-
-# Enable the message, report, category or checker with the given id(s). You can
-# either give multiple identifier separated by comma (,) or put this option
-# multiple time.
-#enable=
-
-# Disable the message, report, category or checker with the given id(s). You
-# can either give multiple identifier separated by comma (,) or put this option
-# multiple time (only on the command line, not in the configuration file where
-# it should appear only once).
-# :E1103: *%s %r has no %r member (but some types could not be inferred)*
-# :W0142: *Used * or ** magic*
-# :W0703: *Catch "Exception"*
-# :R0903: *Too few public methods (%s/%s)*
-# :R0922: *Abstract class is only referenced 1 times*
-# :E1101: *Used when a variable is accessed for an unexistent member. This message belongs to the typecheck checker.* (many false positive)
-
-disable=E1103,W0142,W0703,R0903,R0922,E1101
-
-
-[REPORTS]
-
-# Set the output format. Available formats are text, parseable, colorized, msvs
-# (visual studio) and html
-output-format=text
-
-# Include message's id in output
-include-ids=yes
-
-# Put messages in a separate file for each module / package specified on the
-# command line instead of printing them on stdout. Reports (if any) will be
-# written in a file name "pylint_global.[txt|html]".
-files-output=no
-
-# Tells whether to display a full report or only the messages
-reports=yes
-
-# Python expression which should return a note less than 10 (10 is the highest
-# note). You have access to the variables errors warning, statement which
-# respectively contain the number of errors / warnings messages and the total
-# number of statements analyzed. This is used by the global evaluation report
-# (RP0004).
-evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
-
-# Add a comment according to your evaluation note. This is used by the global
-# evaluation report (RP0004).
-comment=yes
-
-
-[SIMILARITIES]
-
-# Minimum lines number of a similarity.
-min-similarity-lines=4
-
-# Ignore comments when computing similarities.
-ignore-comments=yes
-
-# Ignore docstrings when computing similarities.
-ignore-docstrings=yes
-
-
-[TYPECHECK]
-
-# Tells whether missing members accessed in mixin class should be ignored. A
-# mixin class is detected if its name ends with "mixin" (case insensitive).
-ignore-mixin-members=yes
-
-# List of classes names for which member attributes should not be checked
-# (useful for classes with attributes dynamically set).
-ignored-classes=SQLObject
-
-# When zope mode is activated, add a predefined set of Zope acquired attributes
-# to generated-members.
-zope=no
-
-# List of members which are set dynamically and missed by pylint inference
-# system, and so shouldn't trigger E0201 when accessed.
-generated-members=REQUEST,acl_users,aq_parent
-
-
-[VARIABLES]
-
-# Tells whether we should check for unused import in __init__ files.
-init-import=no
-
-# A regular expression matching the beginning of the name of dummy variables
-# (i.e. not used).
-dummy-variables-rgx=_|dummy
-
-# List of additional names supposed to be defined in builtins. Remember that
-# you should avoid to define new builtins when possible.
-additional-builtins=
-
-
-[MISCELLANEOUS]
-
-# List of note tags to take in consideration, separated by a comma.
-notes=FIXME,XXX,TODO
-
-
-[FORMAT]
-
-# Maximum number of characters on a single line.
-max-line-length=80
-
-# Maximum number of lines in a module
-max-module-lines=1000
-
-# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
-# tab).
-indent-string=' '
-
-
-[BASIC]
-
-# Required attributes for module, separated by a comma
-required-attributes=
-
-# List of builtins function names that should not be used, separated by a comma
-bad-functions=map,filter,apply,input
-
-# Regular expression which should only match correct module names
-module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
-
-# Regular expression which should only match correct module level names
-const-rgx=(([A-Z_][A-Z0-9_]*)|[a-z_][a-z0-9_]{2,30}$|[A-Z_][a-zA-Z0-9]+$|(__.*__))$
-
-# Regular expression which should only match correct class names
-class-rgx=[A-Z_][a-zA-Z0-9]+$
-
-# Regular expression which should only match correct function names
-function-rgx=[a-z_][a-z0-9_]{2,30}$
-
-# Regular expression which should only match correct method names
-method-rgx=[a-z_][a-z0-9_]{2,30}$
-
-# Regular expression which should only match correct instance attribute names
-attr-rgx=[a-z_][a-z0-9_]{2,30}$
-
-# Regular expression which should only match correct argument names
-argument-rgx=[a-z_][a-z0-9_]{2,30}$
-
-# Regular expression which should only match correct variable names
-variable-rgx=[a-z_][a-z0-9_]{2,30}$
-
-# Regular expression which should only match correct list comprehension /
-# generator expression variable names
-inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
-
-# Good variable names which should always be accepted, separated by a comma
-good-names=i,j,k,ex,Run,_
-
-# Bad variable names which should always be refused, separated by a comma
-bad-names=foo,bar,baz,toto,tutu,tata
-
-# Regular expression which should only match functions or classes name which do
-# not require a docstring
-no-docstring-rgx=__.*__
-
-
-[IMPORTS]
-
-# Deprecated modules which should not be used, separated by a comma
-deprecated-modules=regsub,string,TERMIOS,Bastion,rexec
-
-# Create a graph of every (i.e. internal and external) dependencies in the
-# given file (report RP0402 must not be disabled)
-import-graph=
-
-# Create a graph of external dependencies in the given file (report RP0402 must
-# not be disabled)
-ext-import-graph=
-
-# Create a graph of internal dependencies in the given file (report RP0402 must
-# not be disabled)
-int-import-graph=
-
-
-[DESIGN]
-
-# Maximum number of arguments for function / method
-max-args=5
-
-# Argument names that match this expression will be ignored. Default to name
-# with leading underscore
-ignored-argument-names=_.*
-
-# Maximum number of locals for function / method body
-max-locals=15
-
-# Maximum number of return / yield for function / method body
-max-returns=6
-
-# Maximum number of branch for function / method body
-max-branchs=12
-
-# Maximum number of statements in function / method body
-max-statements=50
-
-# Maximum number of parents for a class (see R0901).
-max-parents=7
-
-# Maximum number of attributes for a class (see R0902).
-max-attributes=7
-
-# Minimum number of public methods for a class (see R0903).
-min-public-methods=2
-
-# Maximum number of public methods for a class (see R0904).
-max-public-methods=20
-
-
-[CLASSES]
-
-# List of interface methods to ignore, separated by a comma. This is used for
-# instance to not check methods defines in Zope's Interface base class.
-ignore-iface-methods=isImplementedBy,deferred,extends,names,namesAndDescriptions,queryDescriptionFor,getBases,getDescriptionFor,getDoc,getName,getTaggedValue,getTaggedValueTags,isEqualOrExtendedBy,setTaggedValue,isImplementedByInstancesOf,adaptWith,is_implemented_by
-
-# List of method names used to declare (i.e. assign) instance attributes.
-defining-attr-methods=__init__,__new__,setUp
diff --git a/pyproject.toml b/pyproject.toml
new file mode 100644
index 00000000..deaeb8df
--- /dev/null
+++ b/pyproject.toml
@@ -0,0 +1,180 @@
+[project]
+name = "doit"
+version = "0.37.dev0"
+description = "doit - Automation Tool"
+
+authors = [
+ {name = "Eduardo Naufel Schettino", email = "schettino72@gmail.com"},
+]
+
+dependencies = [
+ "importlib-metadata>=4.4",
+ "doit-py>=0.4.0",
+ "tomli",
+ "cloudpickle",
+ "pytest-coverage>=0.0",
+]
+
+requires-python = ">=3.8"
+readme = "README.rst"
+license = {text = "MIT"}
+keywords = [
+ "build make task automation pipeline task-runner",
+]
+
+classifiers = [
+ "Development Status :: 5 - Production/Stable",
+ "Environment :: Console",
+ "Intended Audience :: Developers",
+ "Intended Audience :: Information Technology",
+ "Intended Audience :: Science/Research",
+ "Intended Audience :: System Administrators",
+ "License :: OSI Approved :: MIT License",
+ "Natural Language :: English",
+ "Operating System :: OS Independent",
+ "Operating System :: POSIX",
+ "Programming Language :: Python :: 3",
+ "Programming Language :: Python :: 3.10",
+ "Programming Language :: Python :: 3.8",
+ "Programming Language :: Python :: 3.9",
+ "Topic :: Scientific/Engineering",
+ "Topic :: Software Development :: Build Tools",
+ "Topic :: Software Development :: Quality Assurance",
+ "Topic :: Software Development :: Testing",
+]
+
+[project.urls]
+Homepage = "http://pydoit.org"
+Documentation = "https://pydoit.org/"
+Source = "https://github.com/pydoit/doit/"
+Tracker = "https://github.com/pydoit/doit/issues"
+
+[project.optional-dependencies]
+dev = [
+ "setuptools>=75.8.0",
+ "pytest>=7.1.0",
+ "coverage>=6.0",
+ "ruff>=0.9.6",
+]
+doc = [
+ "sphinx",
+ "sphinx-press-theme",
+ "sphinx-sitemap",
+ "sphinx-reredirects",
+ ]
+
+[project.scripts]
+doit = "doit.__main__:main"
+
+[build-system]
+requires = ["pdm-backend"]
+build-backend = "pdm.backend"
+
+[dependency-groups]
+docs = [
+ "sphinx-sitemap>=2.6.0",
+ "sphinx-reredirects>=0.1.5",
+ "sphinx-press-theme>=0.9.1",
+ "sphinx>=8.1.3",
+ "sphinx-autoapi>=3.5.0",
+ "autodocsumm>=0.2.14",
+]
+
+[tool.ruff]
+exclude = ["doit/cmd_completion.py"]
+line-length = 90
+
+[tool.ruff.lint]
+ignore = [ "E266", "E301", "E302", "E303", "E305", "E306", "E731"]
+extend-select = [
+ "D419", # empty-docstring
+ "E501", # line-too-long
+ "W291", # trailing-whitespace
+ "PLC0414", # useless-import-alias
+ "PLC2401", # non-ascii-name
+ "PLC2801", # unnecessary-dunder-call
+ "PLC3002", # unnecessary-direct-lambda-call
+ "PLE0101", # return-in-init
+ "F706", # return-outside-function
+ "F704", # yield-outside-function
+ "PLE0115", # nonlocal-and-global
+ "PLE0116", # continue-in-finally
+ "PLE0117", # nonlocal-without-binding
+ "PLE0241", # duplicate-bases
+ "PLE0302", # unexpected-special-method-signature
+ "PLE0604", # invalid-all-object
+ "PLE0605", # invalid-all-format
+ "PLE0643", # potential-index-error
+ "PLE0704", # misplaced-bare-raise
+ "PLE1141", # dict-iter-missing-items
+ "PLE1142", # await-outside-async
+ "PLE1205", # logging-too-many-args
+ "PLE1206", # logging-too-few-args
+ "PLE1307", # bad-string-format-type
+ "PLE1310", # bad-str-strip-call
+ "PLE1507", # invalid-envvar-value
+ "PLE1519", # singledispatch-method
+ "PLE1520", # singledispatchmethod-function
+ "PLE2502", # bidirectional-unicode
+ "PLE2510", # invalid-character-backspace
+ "PLE2512", # invalid-character-sub
+ "PLE2513", # invalid-character-esc
+ "PLE2514", # invalid-character-nul
+ "PLE2515", # invalid-character-zero-width-space
+ "PLE4703", # modified-iterating-set
+ "PLR0124", # comparison-with-itself
+ "PLR0202", # no-classmethod-decorator
+ "PLR0203", # no-staticmethod-decorator
+ "UP004", # useless-object-inheritance
+ "PLR0206", # property-with-parameters
+ "PLR0904", # too-many-public-methods
+ "PLR0911", # too-many-return-statements
+ "PLR0912", # too-many-branches
+ "PLR0913", # too-many-arguments
+ "PLR0914", # too-many-locals
+ "PLR0915", # too-many-statements
+ "PLR0916", # too-many-boolean-expressions
+ "PLR0917", # too-many-positional-arguments
+ "PLR1702", # too-many-nested-blocks
+ "PLR1704", # redefined-argument-from-local
+ "PLR1711", # useless-return
+ "C416", # unnecessary-comprehension
+ "PLR1733", # unnecessary-dict-index-lookup
+ "PLR1736", # unnecessary-list-index-lookup
+ "PLW0108", # unnecessary-lambda
+ "PLW0120", # useless-else-on-loop
+ "PLW0127", # self-assigning-variable
+ "PLW0128", # redeclared-assigned-name
+ "PLW0129", # assert-on-string-literal
+ "B033", # duplicate-value
+ "PLW0131", # named-expr-without-context
+ "PLW0177", # nan-comparison
+ "PLW0211", # bad-staticmethod-argument
+ "PLW0245", # super-without-brackets
+ "PLW0406", # import-self
+ "PLW0602", # global-variable-not-assigned
+ "PLW0603", # global-statement
+ "PLW0604", # global-at-module-level
+ "F401", # unused-import
+ "F841", # unused-variable
+ "E722", # bare-except
+ "PLW0711", # binary-op-exception
+ "PLW1501", # bad-open-mode
+ "PLW1507", # shallow-copy-environ
+ "PLW1508", # invalid-envvar-default
+ "PLW1509", # subprocess-popen-preexec-fn
+ "PLW1514", # unspecified-encoding
+ "PLW2101", # useless-with-lock
+ "PLW3301", # nested-min-max
+]
+
+[tool.pdm.version]
+source = "scm"
+
+[tool.pdm.scripts]
+test-cov.cmd = "pytest --cov=chipflow_lib --cov-report=html"
+test.cmd = "pytest"
+test-docs.cmd = "sphinx-build -b doctest doc/ docs/_build"
+lint.cmd = "ruff check"
+docs.cmd = "sphinx-build doc/ doc/_build/ -W --keep-going"
+
diff --git a/setup.cfg b/setup.cfg
deleted file mode 100644
index 09ad6ad3..00000000
--- a/setup.cfg
+++ /dev/null
@@ -1,13 +0,0 @@
-[pycodestyle]
-
-# E266 too many leading '#' for block comment
-# E301 expected 1 blank line
-# E302: expected 2 blank lines
-# E303: too many blank lines
-# E305: expected 2 blank lines after class or function definition
-# E306: expected 1 blank line before a nested definition
-# E731: do not assign lambda
-# W503: line break before binary operator
-ignore = E266, E301, E302, E303, E305, E306, E731, W503
-max-line-length = 90
-exclude = doit/cmd_completion.py
\ No newline at end of file
diff --git a/setup.py b/setup.py
deleted file mode 100755
index 245f28db..00000000
--- a/setup.py
+++ /dev/null
@@ -1,153 +0,0 @@
-#! /usr/bin/env python3
-
-import sys
-
-from setuptools import setup
-
-
-long_description = '''
-*doit* comes from the idea of bringing the power of build-tools to execute any
-kind of task
-
-*doit* can be uses as a simple **Task Runner** allowing you to easily define ad hoc
-tasks, helping you to organize all your project related tasks in an unified
-easy-to-use & discoverable way.
-
-*doit* scales-up with an efficient execution model like a **build-tool**.
-*doit* creates a DAG (direct acyclic graph) and is able to cache task results.
-It ensures that only required tasks will be executed and in the correct order
-(aka incremental-builds).
-
-The *up-to-date* check to cache task results is not restricted to looking for
-file modification on dependencies. Nor it requires "target" files.
-So it is also suitable to handle **workflows** not handled by traditional build-tools.
-
-Tasks' dependencies and creation can be done dynamically during it is execution
-making it suitable to drive complex workflows and **pipelines**.
-
-*doit* is build with a plugin architecture allowing extensible commands, custom
-output, storage backend and "task loader". It also provides an API allowing
-users to create new applications/tools leveraging *doit* functionality like a framework.
-
-*doit* is a mature project being actively developed for more than 10 years.
-It includes several extras like: parallel execution, auto execution (watch for file
-changes), shell tab-completion, DAG visualisation, IPython integration, and more.
-
-
-
-Sample Code
-===========
-
-Define functions returning python dict with task's meta-data.
-
-Snippet from `tutorial `_:
-
-.. code:: python
-
- def task_imports():
- """find imports from a python module"""
- for name, module in PKG_MODULES.by_name.items():
- yield {
- 'name': name,
- 'file_dep': [module.path],
- 'actions': [(get_imports, (PKG_MODULES, module.path))],
- }
-
- def task_dot():
- """generate a graphviz's dot graph from module imports"""
- return {
- 'targets': ['requests.dot'],
- 'actions': [module_to_dot],
- 'getargs': {'imports': ('imports', 'modules')},
- 'clean': True,
- }
-
- def task_draw():
- """generate image from a dot file"""
- return {
- 'file_dep': ['requests.dot'],
- 'targets': ['requests.png'],
- 'actions': ['dot -Tpng %(dependencies)s -o %(targets)s'],
- 'clean': True,
- }
-
-
-Run from terminal::
-
- $ doit list
- dot generate a graphviz's dot graph from module imports
- draw generate image from a dot file
- imports find imports from a python module
- $ doit
- . imports:requests.models
- . imports:requests.__init__
- . imports:requests.help
- (...)
- . dot
- . draw
-
-
-Project Details
-===============
-
- - Website & docs - `http://pydoit.org `_
- - Project management on github - `https://github.com/pydoit/doit `_
- - Discussion group - `https://groups.google.com/forum/#!forum/python-doit `_
- - News/twitter - `https://twitter.com/pydoit `_
- - Plugins, extensions and projects based on doit - `https://github.com/pydoit/doit/wiki/powered-by-doit `_
-
-license
-=======
-
-The MIT License
-Copyright (c) 2008-2022 Eduardo Naufel Schettino
-'''
-
-setup(name = 'doit',
- description = 'doit - Automation Tool',
- version = '0.37.dev0',
- license = 'MIT',
- author = 'Eduardo Naufel Schettino',
- author_email = 'schettino72@gmail.com',
- url = 'http://pydoit.org',
- classifiers = [
- 'Development Status :: 5 - Production/Stable',
- 'Environment :: Console',
- 'License :: OSI Approved :: MIT License',
- 'Natural Language :: English',
- 'Operating System :: OS Independent',
- 'Operating System :: POSIX',
- 'Programming Language :: Python :: 3',
- 'Programming Language :: Python :: 3.8',
- 'Programming Language :: Python :: 3.9',
- 'Programming Language :: Python :: 3.10',
- 'Intended Audience :: Developers',
- 'Intended Audience :: Information Technology',
- 'Intended Audience :: Science/Research',
- 'Intended Audience :: System Administrators',
- 'Topic :: Software Development :: Build Tools',
- 'Topic :: Software Development :: Testing',
- 'Topic :: Software Development :: Quality Assurance',
- 'Topic :: Scientific/Engineering',
- ],
- keywords = "build make task automation pipeline task-runner",
- project_urls = {
- 'Documentation': 'https://pydoit.org/',
- 'Source': 'https://github.com/pydoit/doit/',
- 'Tracker': 'https://github.com/pydoit/doit/issues',
- },
- packages = ['doit'],
- python_requires='>=3.8',
- install_requires = ['importlib-metadata>=4.4'],
- extras_require={
- 'toml': ['tomli; python_version<"3.11"'],
- # cloudpickle broken on pypy, see #409
- 'cloudpickle': ['cloudpickle; platform_python_implementation!="pypy"'],
- },
- long_description = long_description,
- entry_points = {
- 'console_scripts': [
- 'doit = doit.__main__:main'
- ]
- },
- )