Skip to content

Commit

Permalink
f
Browse files Browse the repository at this point in the history
  • Loading branch information
mferrera committed Oct 2, 2023
1 parent a46f823 commit 827960c
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 77 deletions.
36 changes: 0 additions & 36 deletions .pre-commit-config.yaml

This file was deleted.

21 changes: 8 additions & 13 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -83,9 +83,7 @@ up your fork for local development (first time):
$ source bin/activate
$ cd /your_path_to_git_clone/xtgeo/
$ pip install pip -U
$ pip install -r requirements/requirements_dev.txt
$ python setup.py clean
$ python setup.py develop
$ pip install ".[dev,docs]"
$ pytest # to check that stuff works
4. Create a branch for local development:
Expand All @@ -100,13 +98,12 @@ Now you can make your changes locally.

.. code-block:: bash
$ flake8 <your edited code>
$ pylint <your edited code>
$ Use `pytest` for running tests
$ Run `black` on your python code, then there is no discussions on formatting
To get ``flake8``, ``pylint`` and ``black`` and just pip install them into
your virtualenv.
$ black src tests
$ flake8 src tests
$ isort src tests
$ mypy src
$ pylint src tests
$ pytest tests
6. If you want to edit C code, take contact with the author for detailed instructions.

Expand Down Expand Up @@ -137,9 +134,7 @@ and it is targeted to Equinor usage using bash shell in Linux:
$ source ~/venv/py36_rms12.0.2/bin/activate
$ cd path_to_xtgeo/
$ python -m pip install pip -U
$ pip install requirements/requirements_dev.txt
$ python setup.py clean
$ python setup.py develop
$ pip install ".[dev]"
$ pytest
Now you have an editable install in your virtual environment that can be ran
Expand Down
10 changes: 9 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,6 @@ dependencies = [
"segyio>1.8.0",
"shapely>=1.6.2",
"tables;platform_system != 'Darwin'", # TODO: update when fixed for mac
"typing-extensions",
]

[project.urls]
Expand All @@ -74,6 +73,7 @@ dev = [
"flake8",
"isort",
"hypothesis",
"mypy",
"pylint",
"pytest",
"pytest-benchmark",
Expand All @@ -83,6 +83,7 @@ dev = [
"pytest-mock",
"pytest-snapshot",
"pytest-xdist",
"typing-extensions",
]
docs = [
"pydocstyle",
Expand All @@ -109,13 +110,20 @@ exclude = '''
| buck-out
| build
| dist
| _theversion.py
# The following are specific to Black, you probably don't want those.
| blib2to3
| tests/data
| profiling
)/
'''

[tool.isort]
profile = "black"

[tool.mypy]
ignore_missing_imports = true

[tool.pydocstyle]
convention = "google"
match = '(?!(test_|_)).*\.py'
Expand Down
27 changes: 0 additions & 27 deletions scripts/swig_manylinux.sh

This file was deleted.

0 comments on commit 827960c

Please sign in to comment.