aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMatthias Baumgartner <dev@igsor.net>2023-03-05 19:12:57 +0100
committerMatthias Baumgartner <dev@igsor.net>2023-03-05 19:12:57 +0100
commit3ae93a405724ca6b5ddeb0b458fcc95685f83f09 (patch)
tree634198c34aae3c0306ce30ac7452abd7b53a14e8
parent87004fa65cc4833cfdbd9a24ba149123c7020edb (diff)
downloadbsfs-3ae93a405724ca6b5ddeb0b458fcc95685f83f09.tar.gz
bsfs-3ae93a405724ca6b5ddeb0b458fcc95685f83f09.tar.bz2
bsfs-3ae93a405724ca6b5ddeb0b458fcc95685f83f09.zip
build fixes
-rw-r--r--README.md8
-rw-r--r--doc/source/installation.rst3
-rw-r--r--setup.py13
3 files changed, 17 insertions, 7 deletions
diff --git a/README.md b/README.md
index 1956752..796c198 100644
--- a/README.md
+++ b/README.md
@@ -25,7 +25,13 @@ Install bsfs as editable from the git repository:
$ cd bsfs
$ pip install -e .
-Install the following additional packages besides bsfs:
+If you want to develop (*dev*), run the tests (*test*), edit the
+documentation (*doc*), or build a distributable (*build*),
+install bsfs with the respective extras:
+
+ $ pip install -e .[dev,doc,build,test]
+
+Or, you can manually install the following packages besides BSFS:
$ pip install coverage mypy pylint
$ pip install sphinx sphinx-copybutton furo
diff --git a/doc/source/installation.rst b/doc/source/installation.rst
index c7d8fba..4316136 100644
--- a/doc/source/installation.rst
+++ b/doc/source/installation.rst
@@ -2,9 +2,6 @@
Installation
============
-Installation
-------------
-
Install *BSFS* via pip::
pip install --extra-index-url https://pip.bsfs.io bsfs
diff --git a/setup.py b/setup.py
index 747e853..f6bd3e8 100644
--- a/setup.py
+++ b/setup.py
@@ -9,14 +9,15 @@ setup(
author='Matthias Baumgartner',
author_email='dev@bsfs.io',
description='A content-aware graph file system.',
- long_description=open(os.path.join(os.path.dirname(__file__), 'README')).read(),
+ long_description=open(os.path.join(os.path.dirname(__file__), 'README.md')).read(),
license='BSD',
license_files=('LICENSE', ),
url='https://www.bsfs.io/bsfs/',
download_url='https://pip.bsfs.io',
# packages
- packages=[p for p in find_packages() if p.startswith('bsfs')],
+ packages=find_packages(include=['bsfs']),
+ package_dir={'bsfs': 'bsfs'},
# data files are included if mentioned in MANIFEST.in
include_package_data=True,
@@ -28,10 +29,16 @@ setup(
},
# dependencies
+ python_requires=">=3.7",
install_requires=(
'rdflib', # schema and sparql storage
'hopcroftkarp', # ast matching
'numpy', # distance functions for sparql store
),
- python_requires=">=3.7",
+ extras_require={
+ 'dev': ['coverage', 'mypy', 'pylint'],
+ 'doc': ['sphinx', 'furo', 'sphinx-copybutton'],
+ 'test': [],
+ 'build': ['build'],
+ },
)