Metadata-Version: 2.4
Name: apgman
Version: 0.2.2
Summary: Python bindings for APGman shell scripts
Author: NNlk05
License-Expression: CC0-1.0
Project-URL: Home, https://github.com/NNlk05/apgman
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: POSIX :: Linux
Classifier: Topic :: Utilities
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# APGman Python API README

> FOR THE MAIN README PLEASE SEE [README.md](https://github.com/NNlk05/apgman/blob/main/README.md)

## To use

### Install

```bash
pip install apgman
```

## Import

```python
import apgman
```

## Functions

`add_rule(rule_file: str) -> str`

Adds a `.rule` file to APGman.

`build(rule: str = 'b3s23', symmetry: str = 'C1') -> str`

Builds a new instance of APGman

`init(path: Optional[str] = None) -> str`

Installs APGman on your system.

`run(rule: str = 'b3s23', symmetry: str = 'C1', *args: str) -> str`

Runs a search using apgman

## Example

```python
# Can be also found in /example.py
import apgman

apgman.build("b3s23", "C1")
apgman.run("b3s23", "C1", "-t", "1", "-n", "1000000", "-p", "4")
```
