Skip to content

Commit

Permalink
fix: update the general files to align with PyAnsys standards (#3151)
Browse files Browse the repository at this point in the history
* fix: update pyproject.toml mail id

* docs: add contributors file and renale authors file

* docs: move code owners file

* docs: clean up precommit

* Update pyproject.toml

Co-authored-by: Jorge Martínez <28702884+jorgepiloto@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: German <28149841+germa89@users.noreply.github.com>

* docs: clean up codespell precommit

---------

Co-authored-by: Jorge Martínez <28702884+jorgepiloto@users.noreply.github.com>
Co-authored-by: German <28149841+germa89@users.noreply.github.com>
  • Loading branch information
3 people committed Jun 4, 2024
1 parent 28b0b69 commit 3dcb798
Show file tree
Hide file tree
Showing 8 changed files with 45 additions and 28 deletions.
8 changes: 8 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
12 changes: 12 additions & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
@@ -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.
10 changes: 0 additions & 10 deletions AUTHORS.md

This file was deleted.

7 changes: 0 additions & 7 deletions CODEOWNERS

This file was deleted.

16 changes: 16 additions & 0 deletions CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -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)
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,15 +123,15 @@ 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
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/).
14 changes: 6 additions & 8 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -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"
Expand Down Expand Up @@ -143,7 +142,6 @@ default_section = "THIRDPARTY"
skip_glob = ["__init__.py"]
src_paths = ["doc", "src", "tests"]


[tool.coverage.run]
source = ["ansys/pymapdl"]
omit = [
Expand All @@ -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 = [
Expand Down

0 comments on commit 3dcb798

Please sign in to comment.