diff options
| -rw-r--r-- | README.md | 8 | ||||
| -rw-r--r-- | doc/source/installation.rst | 3 | ||||
| -rw-r--r-- | setup.py | 13 |
3 files changed, 17 insertions, 7 deletions
@@ -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 @@ -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'], + }, ) |