Skip to content

Commit

Permalink
Merge pull request #35 from scrambldchannel/chore/publish_beta_version
Browse files Browse the repository at this point in the history
docs: update README
  • Loading branch information
scrambldchannel authored Oct 11, 2022
2 parents 492ef82 + 5a1f3df commit 3a62138
Showing 1 changed file with 18 additions and 4 deletions.
22 changes: 18 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,26 @@ A Python package that simplifies working with files associated with a TM1 server

## Installation

If you want to try it out, you can install directly from this repo. I'll think about publishing it to PyPi once it's considered a bit more stable.

```sh
pip install git+https://github.com/scrambldchannel/tm1-file-tools.git
pip install tm1filetools
```

## Testing
## Example Usage

`python -m pytest tests`
```python
from pathlib import Path
from tm1filetools import TM1FileTool

path = Path("./data")

ft = TM1FileTool(path)

orphans = ft.get_orphan_rules()

...

ft.delete_all_blbs()

...
```

0 comments on commit 3a62138

Please sign in to comment.