Skip to content

Commit

Permalink
Switched build system to poetry.
Browse files Browse the repository at this point in the history
  • Loading branch information
thvitt committed Jun 15, 2021
1 parent 0ad8d95 commit e9c57fc
Show file tree
Hide file tree
Showing 6 changed files with 42 additions and 49 deletions.
1 change: 1 addition & 0 deletions .gitignore
Expand Up @@ -21,3 +21,4 @@ NOTES
.cache
.pytest_cache
pytest.xml
poetry.lock
9 changes: 5 additions & 4 deletions README.rst
Expand Up @@ -37,21 +37,22 @@ There are currently three different long-running branches:
Installation and Requirements
=============================

PyDelta requires **Python 3.3 or newer**. It has quite a set of dependencies (NumPy, Pandas, SciPy, SciKit-Learn, …), but it comes with a setup script that installs it with its dependencies.
PyDelta requires **an up-to-date Python 3**. It has quite a set of dependencies (NumPy, Pandas, SciPy, SciKit-Learn, …) that are declared in its pyproject.toml.

If you only wish to use it, not to hack on it, pip can clone and install it for you::

pip install git+https://github.com/cophi-wue/pydelta@next

(Note that the Python 3 version of pip is sometimes called ``pip3``).

Developers can clone the repo and run pip to install::
Developers can clone the repo and use [Poetry](https://python-poetry.org/) to setup a virtual environment for development.

git clone -b next https://github.com/cophi-wue/pydelta
cd pydelta
pip install -r requirements.txt
poetry install

Tests can be run using `pytest`. To build the documentation `cd docs && make html`.

You may need to install numpy, scipy, and Cython separately first.


----
Expand Down
36 changes: 36 additions & 0 deletions pyproject.toml
@@ -0,0 +1,36 @@
[tool.poetry]
name = "delta"
version = "2.1.0.dev1"
description = "Stylometry toolkit"
authors = [
"Thorsten Vitt <thorsten.vitt@uni-wuerzburg.de>",
"Fotis Jannidis <fotis.jannidis@uni-wuerzburg.de>"
]
license = "GPL-3.0-or-later"
readme = "README.rst"

[tool.poetry.dependencies]
python = ">=3.7.1,<3.10"
numpy = "^1.20.3"
pandas = "^1.2.4"
scipy = "^1.6.3"
matplotlib = "^3.4.2"
regex = "^2021.4.4"
scikit-learn = "^0.24.2"
scikit-learn-extra = "^0.2.0"
joblib = "^1.0.1"

[tool.poetry.dev-dependencies]
pytest = "^6.2.4"
pytest-cov = "^2.12.1"
Sphinx = "^4.0.2"
ipykernel = "^5.5.5"
nbsphinx = "^0.8.6"

[tool.pytest.ini_options]
addopts = "--doctest-modules --junit-xml pytest.xml"
nb_diff_ignore = "/cells/*/output"

[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"
9 changes: 0 additions & 9 deletions requirements.txt

This file was deleted.

10 changes: 0 additions & 10 deletions setup.cfg

This file was deleted.

26 changes: 0 additions & 26 deletions working-requirements.txt

This file was deleted.

0 comments on commit e9c57fc

Please sign in to comment.