new exports and restructuring
All checks were successful
/ mypy (push) Successful in 13s
/ pylint (push) Successful in 10s
/ lint-and-typing (push) Successful in 16s
/ publish-artifacts (push) Successful in 8s
/ release (push) Successful in 6s
/ build-artifacts (push) Successful in 7s

This commit is contained in:
Firq 2024-10-17 23:32:02 +02:00
parent 43d21deeed
commit fc80fc9b84
Signed by: Firq
GPG key ID: 3ACC61C8CEC83C20
2 changed files with 18 additions and 1 deletions

View file

@ -17,7 +17,9 @@ specified depencencies are not hosted on that index.
## Usage
`skyeweave` is a CLI application, meaning it needs to be accessed via the commandline.
### commandline
`skyeweave` is primarily a CLI application.
The following options are available:
@ -39,6 +41,18 @@ skyeweave --output out --id 70
This would generate the expressions for Scathach (Servant Id 70) in the folder out, using subfolders to better separate the outputs of multiple runs.
### python scripts [EXPERIMENTAL]
`skyeweave` can also be used in other Python scripts.
```python
from skyeweave import compose
compose(70)
```
This feature will be expanded upon in future releases.
## Issues / Support
If there are any issues with `skyeweave`, feel free to reach out to me using the AtlasAcademy discord (`#dev-corner`) or create an issue in this repo.

3
test.py Normal file
View file

@ -0,0 +1,3 @@
from skyeweave import compose
compose(70)