Skip to content

Commit

Permalink
Reworked main library __init__() to include author and helper links
Browse files Browse the repository at this point in the history
  • Loading branch information
Inkaros committed Jul 21, 2024
1 parent aec0a1f commit 5c5ed6b
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 7 deletions.
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ build-backend = "hatchling.build"
# Project metadata section. Provides the general ID information about the project.
[project]
name = "ataraxis-automation"
version = "3.0.2"
version = "3.0.3"
description = "Provides scripts that support tox-based development automation pipelines used by other Sun Lab projects."
readme = "README.md"
license = { file = "LICENSE" }
Expand Down
9 changes: 3 additions & 6 deletions src/ataraxis_automation/__init__.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
"""This library exposes functions used by tox tasks to automate project development and provides a cli-interface for
calling these functions.
The library is not designed to be used directly. Instead, it is meant to be used with 'tox' and other helper packages
like 'mypy', 'ruff', 'stubgen'. The functions exposed through this library augment the functionality of these
helpers by either setting-up, tearing-down or otherwise supporting their runtime.
All functions in this library assume the project they work with is formatted according to Sun Lab standards. Therefore,
significant refactoring may be required to use this library for projects that do not follow those standards.
See https://github.com/Sun-Lab-NBB/ataraxis-automation for more details.
API documentation: https://ataraxis-automation-api-docs.netlify.app/
Author: Ivan Kondratyev (Inkaros)
"""

0 comments on commit 5c5ed6b

Please sign in to comment.