Skip to content

Commit

Permalink
Migrate to pyproject.toml (#61)
Browse files Browse the repository at this point in the history
* move to pyproject.toml

* update CHANGELOG

* use build utility

* build only wheel

* keep module in project root
  • Loading branch information
atimin authored Dec 22, 2022
1 parent 76205cc commit ef7d27b
Show file tree
Hide file tree
Showing 12 changed files with 75 additions and 84 deletions.
11 changes: 5 additions & 6 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,10 @@ jobs:
steps:
- uses: actions/checkout@v2
- name: Update pip
run: python3 -m pip install --no-cache --upgrade pip setuptools wheel

- name: Install dependencies
run: pip3 install .
run: python3 -m pip install --no-cache --upgrade pip pipx

- name: Build package
run: python3 setup.py bdist_wheel
run: pipx run build --wheel

- uses: actions/upload-artifact@master
with:
Expand Down Expand Up @@ -78,6 +75,8 @@ jobs:
with:
name: package
path: ./dist
- name: Upgrade pip
run: pip install -U pip

- name: Install package
run: python3 -m pip install dist/*
Expand All @@ -86,7 +85,7 @@ jobs:
run: pip3 install .[test,lint]

- name: Lint main
run: pylint ./pkg/
run: pylint ./reduct

- name: Lint tests
run: pylint ./tests
Expand Down
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
build/
pkg/reduct/VERSION
reduct/VERSION
*.egg-info
.venv
.gitignore
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Changed:

- Update documentation after rebranding, [PR-59](https://github.com/reductstore/reduct-py/pull/59)
- Update documentation after rebranding, [PR-59](https://github.com/reductstore/reduct-py/pull/59)
- Migrate to pyproject.toml, [PR-61](https://github.com/reductstore/reduct-py/pull/61)

## [1.1.0] - 2022-11-29

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
[![PyPI - Downloads](https://img.shields.io/pypi/dm/reduct-py)](https://pypi.org/project/reduct-py/)
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/reductstore/reduct-py/ci.yml?branch=main)](https://github.com/reductstore/reduct-py/actions)

This package provides an asynchronous HTTP client for interacting with the [ReductStore](https://www.reduct.store) service. It is written in Python
This package provides an asynchronous HTTP client for interacting with the [ReductStore](https://www.reduct.store) service.

## Features

Expand Down
3 changes: 2 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
site_name: ReductStore Client SDK for Python
site_description: The ReductStore Client SDK for Python is a Python client for ReductStore, a time series database for blob data
site_url: "https://py.reduct.store"
docs_dir: .
nav:
Expand All @@ -16,7 +17,7 @@ nav:

repo_name: reductstore/reduct-py
repo_url: https://github.com/reductstore/reduct-py
edit_uri: edit/main/docs
edit_uri: edit/main/


# Configuration
Expand Down
64 changes: 64 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,2 +1,66 @@
[build-system]
requires = ["setuptools>=40.8.0", "wheel"]

[project]

name = "reduct-py"
version = "1.1.0"
description = "ReductStore Client SDK for Python"
requires-python = ">=3.7"
readme = "README.md"
license = { file = "LICENSE" }
keywords = ["sdk", "reductstore", "api client", "database", "time series database"]
authors = [
{ name = "Alexey Timin", email = "[email protected]" },
{ name = "Ciaran Moyne" }
]
maintainers = [
{ email = "[email protected]", name = "Alexey Timin" }
]

classifiers = [
"Development Status :: 4 - Beta",
"Programming Language :: Python :: 3 :: Only",
"Framework :: aiohttp",
"Intended Audience :: Information Technology",
"Intended Audience :: Developers",
"Intended Audience :: System Administrators",
"Operating System :: OS Independent",
"Topic :: Database :: Front-Ends",
"License :: OSI Approved :: MIT License",
]

dependencies = ["aiohttp~=3.8", "pydantic~=1.9", "deprecation~=2.1"]

[project.optional-dependencies]
test = [
"pytest~=7.1",
"pytest-mock~=3.10",
"pytest-asyncio~=0.18"
]

lint = ["pylint~=2.14"]
format = ["black~=22.6"]
docs = [
"mkdocs~=1.3",
"mkdocs-material~=8.3",
"plantuml-markdown~=3.5",
"mkdocs-same-dir~=0.1",
"mkdocstrings[python]~=0.19"
]

[project.urls]
ReductStore = "https://www.reduct.store"
Documentation = "https://py.reduct.store/"
Source = "https://github.com/reductstore/reduct-py"
Changelog = "https://github.com/reductstore/reduct-py/blob/main/CHANGELOG.md"
Twitter = "https://twitter.com/ReductStore"
Blog = "https://dev.to/reductstore"


[tool.pytest.ini_options]
asyncio_mode = "strict"

[tool.pylint]
max-line-length = 88
extension-pkg-whitelist = "pydantic"
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
74 changes: 0 additions & 74 deletions setup.py

This file was deleted.

0 comments on commit ef7d27b

Please sign in to comment.