Mentions légales du service

Skip to content
Snippets Groups Projects
Commit fb826c2a authored by PAPERMAN Charles's avatar PAPERMAN Charles
Browse files

Merge branch 'packaging' into 'master'

Added pyproject.toml and installation instructions

See merge request !1
parents 9088f000 12443d39
Branches
Tags
1 merge request!1Added pyproject.toml and installation instructions
Install
=======
NetworkDisk requires Python3.6.
Below we assume you have the default Python environment already configured on
your computer and you intend to install ``networkx`` inside of it. If you want
to create and work with Python virtual environments, please follow instructions
on `venv <https://docs.python.org/3/library/venv.html>`_ and `virtual
environments <http://docs.python-guide.org/en/latest/dev/virtualenvs/>`_.
First, make sure you have the latest version of ``pip`` (the Python package manager)
installed. If you do not, refer to the `Pip documentation
<https://pip.pypa.io/en/stable/installing/>`_ and install ``pip`` first.
Installing with dependencies
----------------------------
To install ``QueryBuilder`` with dependencies from source, run the following command from the package root directory::
$ python3 -m pip install .
To install optional dependencies to run tests or generate documentation, run the following commands from the package root directory::
$ python3 -m pip install .[test]
$ python3 -m pip install .[doc]
[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"
[project]
name = "querybuilder"
dynamic = ["version"]
description = "An SQL query builder written in Python."
readme = "README.rst"
license = "BSD-3-Clause"
authors = [
{ name = "Bruno Guillon", email = "bruno.guillon@uca.fr" },
{ name = "Charles Paperman", email = "charles.paperman@univ-lille.fr" },
]
keywords = [
"database",
]
classifiers = [
"Development Status :: 4 - Beta",
"License :: OSI Approved :: BSD License",
"Topic :: Utilities",
]
dependencies = [
"termcolor",
"pygments",
]
[project.optional-dependencies]
test = [
"pytest",
"pytest-cov",
"more-itertools",
"querybuilder[doc]"
]
doc = [
"numpydoc",
"matplotlib",
"sphinx",
"sphinx_rtd_theme",
"sphinx_autorun",
"sphinx_copybutton"
]
#[project.urls]
#Homepage = "https://networkdisk.inria.fr"
#documentation = "https://networkdisk.inria.fr/documentation"
#repository = "https://gitlab.inria.fr/guillonb/networkdisk"
[tool.hatch.version]
path = "querybuilder/__init__.py"
[tool.hatch.build.targets.sdist]
include = [
"/querybuilder",
]
......@@ -7,3 +7,4 @@ sqlite = sqlitemodule.dialect.sqlite
__all__ = ["sql", "sqlite"]
#__dir__ = lambda: ["sql", "sqlite"]
__version__ = "0.1"
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment