Skip to content

Commit

Permalink
added pyproject.toml and updated readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
withjak committed Sep 22, 2024
1 parent 1a6884a commit 75b2930
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,9 @@ What Makes threadx Interesting?
- [TODO](#TODO)

## Install
TODO
```bash
pip install threadx
```

## Usage

Expand Down Expand Up @@ -180,6 +182,8 @@ thread('./data.log', *pipeline) # works jsut like any other function.
## Why I Built This
After spending a few years working with Clojure, I found myself missing its threading macros when I returned to Python (for a side project). Sure, Python has some tools for chaining operations, but nothing quite as elegant or powerful as what I was used to.

## TODO
- Benchmarking code for performance both time and memory (if possible).
- Publish it on pypi





34 changes: 34 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[project]
name = "threadx"
version = "0.1.0a1"
authors = [
{ name="Akshay Patel", email="[email protected]" },
]
description = "Chaining function calls on steroids"
readme = "README.md"
keywords = [
"chain",
"chaining",
"threading",
"pipeline",
"pipe",
"function chaining",
"data transformation",
"functional programming",
"compose functions",
"clojure"
]
requires-python = ">=3.8"
classifiers = [
"Programming Language :: Python :: 3",
"License :: OSI Approved :: Apache Software License",
"Operating System :: OS Independent",
]

[project.urls]
Homepage = "https://github.com/withjak/threadx"
Issues = "https://github.com/withjak/threadx/issues"

0 comments on commit 75b2930

Please sign in to comment.