Skip to content

Commit

Permalink
Update Python packaging files to use new best practices
Browse files Browse the repository at this point in the history
Signed-off-by: Steffen Vogel <steffen.vogel@opal-rt.com>
  • Loading branch information
stv0g committed Jun 17, 2024
1 parent 824caa6 commit 9a99426
Show file tree
Hide file tree
Showing 3 changed files with 64 additions and 21 deletions.
17 changes: 13 additions & 4 deletions documentation/Install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ User Installation
$ git clone https://github.com/sogno-platform/cimpy.git
$ cd cimpy
$ python setup.py install
$ python3 -m pip install .
or

.. code-block:: bash
$ pip install cimpy
$ python3 -m pip install cimpy
Developer Installation
----------------------
Expand All @@ -24,10 +24,19 @@ Developer Installation
$ git clone https://github.com/sogno-platform/cimpy.git
$ cd cimpy
$ python setup.py develop
$ python3 -m pip install -e .[dev]
or

.. code-block:: bash
$ pip install --pre cimpy
$ python3 -m pip install --pre cimpy
Building a distributable package
--------------------------------

.. code-block:: bash
$ python3 -m pip install --upgrade build
$ python3 -m build
52 changes: 51 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,2 +1,52 @@
[tool.black]
[project]
name = "cimpy"
version = "1.0.2"
description = "Python package for import, modification and export of CIM grid data"
authors = [
{name="Institute for Automation of Complex Power Systems"},
{name="OPAL-RT Technologies"}
]
readme = "README.md"
keywords = ["cim", "cgmes"]

dependencies = [
"lxml",
"xmltodict",
"chevron",
]

requires-python = ">=3.8"

classifiers = [
"Development Status :: 5 - Production/Stable",

"License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)",

"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11"
]

[project.urls]
Homepage = "https://sogno.energy/cimpy/"
Documentation = "https://sogno.energy/cimpy/"
Repository = "https://github.com/sogno-platform/cimpy"
Issues = "https://github.com/sogno-platform/cimpy/issues"

[project.optional-dependencies]
dev = [
"pytest",
"pytest-check"
]

[build-system]
requires = ["setuptools >= 61.0"]
build-backend = "setuptools.build_meta"

[tool.setuptools]
include-package-data = true


[tool.black]
line-length = 120
16 changes: 0 additions & 16 deletions setup.py

This file was deleted.

0 comments on commit 9a99426

Please sign in to comment.