diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000000..8c98f5d41e --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,8 @@ +# This is a comment. +# Each line is a file pattern followed by one or more owners. + +# These owners will be the default owners for everything in +# the repo. Unless a later match takes precedence, +# they will be requested for review when someone opens a pull request. + +* @ansys/pymapdl-maintainers diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 8e5b778acc..0be81184b5 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -47,7 +47,7 @@ repos: rev: v2.3.0 hooks: - id: codespell - args: ["--toml", "pyproject.toml", "--ignore-words", "doc/styles/config/vocabularies/ANSYS/accept.txt"] + args: ["--toml", "pyproject.toml"] additional_dependencies: ["tomli"] # - repo: https://github.com/pycqa/pydocstyle diff --git a/AUTHORS b/AUTHORS new file mode 100644 index 0000000000..7f66fe7fbf --- /dev/null +++ b/AUTHORS @@ -0,0 +1,12 @@ +# This is the list of PyMAPDL's significant contributors. +# +# This file does not necessarily list everyone who has contributed code. +# +# For contributions made under a Corporate CLA, the organization is +# added to this file. +# +# If you have contributed to the repository and want to be added to this file, +# submit a request. +# +# +ANSYS, Inc. diff --git a/AUTHORS.md b/AUTHORS.md deleted file mode 100644 index b17949c707..0000000000 --- a/AUTHORS.md +++ /dev/null @@ -1,10 +0,0 @@ -# Authors - -## Project Lead - -* [German Martinez Ayuso](https://github.com/germa89) - -## Contributors - -* [Alex Kaszynski](https://github.com/akaszynski) -* [Camille Latapie](https://github.com/clatapie) diff --git a/CODEOWNERS b/CODEOWNERS deleted file mode 100644 index 7b9b2f49b0..0000000000 --- a/CODEOWNERS +++ /dev/null @@ -1,7 +0,0 @@ -# Repository codeowners -# -# Reference: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners - -/.ci/ @ansys/pymapdl-maintainers -/.github/ @ansys/pymapdl-maintainers -pyproject.toml @ansys/pymapdl-maintainers diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md new file mode 100644 index 0000000000..f92c9cd33c --- /dev/null +++ b/CONTRIBUTORS.md @@ -0,0 +1,16 @@ +# Contributors + +## Project Lead + +* [German Martinez Ayuso](https://github.com/germa89) + +## Individual Contributors + +* [Alex Kaszynski](https://github.com/akaszynski) +* [Camille Latapie](https://github.com/clatapie) +* [Jamil Hajjar](https://github.com/Gryfenfer97) +* [Jorge Martínez](https://github.com/jorgepiloto) +* [Kathy Pipet](https://github.com/PipKat) +* [Maxime Rey](https://github.com/MaxJPRey) +* [Revathy Venugopal](https://github.com/Revathyvenugopal162) +* [Roberto Pastor](https://github.com/RobPasMue) diff --git a/README.md b/README.md index fc16cc054d..0ad935a6b7 100644 --- a/README.md +++ b/README.md @@ -123,7 +123,7 @@ the most recent citation. ## License and acknowledgments -[PyMAPDL](https://mapdl.docs.pyansys.com/version/stable/) is licensed under +[PyMAPDL](https://mapdl.docs.pyansys.com/) is licensed under [the MIT license](https://github.com/ansys/pymapdl/blob/main/LICENSE). [ansys-mapdl-core](https://pypi.org/project/ansys-mapdl-core/) package @@ -131,7 +131,7 @@ makes no commercial claim over Ansys whatsoever. This tool extends the functionality of ``MAPDL`` by adding a Python interface to the MAPDL service without changing the core behavior or license of the original software. The use of the -interactive APDL control of [PyMAPDL](https://mapdl.docs.pyansys.com/version/stable/) +interactive APDL control of [PyMAPDL](https://mapdl.docs.pyansys.com/) requires a legally licensed local copy of Ansys. To get a copy of Ansys, visit [Ansys](https://www.ansys.com/). diff --git a/pyproject.toml b/pyproject.toml index d1d414e925..ad9ce5c1be 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -10,12 +10,8 @@ description = "A Python wrapper for Ansys MAPDL." readme = "README.md" requires-python = ">=3.9,<3.13" # Update also 'MINIMUM_PYTHON_VERSION' in src/ansys/mapdl/core/__init__.py license = {file = "LICENSE"} -authors = [ - {name = "Ansys, Inc.", email = "pyansys.maintainers@ansys.com"}, -] -maintainers = [ - {name = "PyAnsys developers", email = "pyansys.maintainers@ansys.com"}, -] +authors = [{ name = "ANSYS, Inc.", email = "pyansys.core@ansys.com" }] +maintainers = [{ name = "ANSYS, Inc.", email = "pyansys.core@ansys.com" }] dependencies = [ "ansys-api-mapdl==0.5.1", # supports at least 2020R2 - 2022R1 "ansys-mapdl-reader>=0.51.7", @@ -113,6 +109,9 @@ name = "ansys.mapdl.core" [project.urls] Source = "https://github.com/ansys/pymapdl" +Issues = "https://github.com/ansys/pymapdl/issues" +Documentation = "https://mapdl.docs.pyansys.com" +Tracker = "https://github.com/ansys/pymapdl/issues" [project.scripts] pymapdl_convert_script = "ansys.mapdl.core.cli:old_pymapdl_convert_script_entry_point" @@ -143,7 +142,6 @@ default_section = "THIRDPARTY" skip_glob = ["__init__.py"] src_paths = ["doc", "src", "tests"] - [tool.coverage.run] source = ["ansys/pymapdl"] omit = [ @@ -159,9 +157,9 @@ show_missing = true [tool.codespell] skip = '*.pyc,*.txt,*.gif,*.png,*.jpg,*.js,*.html,*.doctree,*.ttf,*.woff,*.woff2,*.eot,*.mp4,*.inv,*.pickle,*.ipynb,flycheck*,./.git/*,./.hypothesis/*,*.yml,./doc/build/*,./doc/images/*,./dist/*,*~,.hypothesis*,./doc/source/examples/*,*cover,*.dat,*.mac,*.cdb,*.CDB,build,./docker/mapdl/v*,./factory/*,./ansys/mapdl/core/mapdl_functions.py,PKG-INFO,*.mypy_cache/*,./docker/mapdl/*,./_unused/*' -ignore-words = "doc/styles/config/vocabularies/ANSYS/accept.txt" quiet-level = 3 ignore-regex=".*codespell-ignore$|NORML|POIN" +ignore-words = "doc/styles/config/vocabularies/ANSYS/accept.txt" [tool.numpydoc_validation] checks = [