Metadata-Version: 2.1
Name: acslib
Version: 0.1.2
Summary: A library for interacting with Access Control Systems like Genetec or Ccure9k
Author-email: Jeremy Gibson <jmgibso3@ncsu.edu>, Luc Sanchez <lgsanche@ncsu.edu>
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: pydantic>=2.5.3, <3.0.0
Requires-Dist: sat-utils>=1.1.12, <2.0.0
Requires-Dist: pytest>=6.2.5, <7.0.0 ; extra == "dev"
Requires-Dist: pytest-cov>=4.0.0, <5.0.0 ; extra == "dev"
Requires-Dist: pytest-mock>=3.10.0, <4.0.0 ; extra == "dev"
Requires-Dist: coverage[toml]>=6.2 ; extra == "dev"
Requires-Dist: black>=23.3.0, <24.0.0 ; extra == "dev"
Requires-Dist: ruff==0.1.1 ; extra == "dev"
Requires-Dist: mkdocs-material>=9.4.6, <10.0.0 ; extra == "dev"
Requires-Dist: pymdown-extensions>=10.3.1, <11.0.0 ; extra == "dev"
Requires-Dist: mkdocs-include-markdown-plugin>=6.0.3, <7.0.0 ; extra == "dev"
Requires-Dist: mkdocstrings>=0.23.0, <1.0.0 ; extra == "dev"
Requires-Dist: mkdocstrings-python>=1.7.3, <2.0.0 ; extra == "dev"
Requires-Dist: Pygments>=2.10.0, <3.0.0 ; extra == "dev"
Requires-Dist: bandit>=1.7.4, <2.0.0 ; extra == "dev"
Requires-Dist: bandit[toml]>=1.7.4, <2.0.0 ; extra == "dev"
Requires-Dist: pre-commit>=2.16.0, <3.0.0 ; extra == "dev"
Requires-Dist: isort>=5.10.1, <6.0.0 ; extra == "dev"
Requires-Dist: pyupgrade>=2.29.1, <3.0.0 ; extra == "dev"
Requires-Dist: flit>=3.8.0, <4.0.0 ; extra == "dev"
Requires-Dist: Faker>=20.0.0, <21.0.0 ; extra == "dev"
Project-URL: Homepage, https://github.ncsu.edu/SAT/acslib
Provides-Extra: dev

# Access Control Systems Library

A library for interacting with Access Control Systems like Genetec or Ccure9k. This is a work in progress and is not ready for production use.

Currently development is heavily influenced by Ccure9k, but the goal is to abstract the differences between the two systems and provide a common
interface for interacting with them.

* Free software: MIT
* Documentation: <https://github.com/ncstate-sat/acslib>

## Features

* Currently supports Search for `Personnel`, `Clearances`, and `Credentials` in Ccure9k
* Supports search by custom fields.

## Usage

### Find a person by name

```python
import acslib

ccure_api = acslib.CcureAPI()
response = ccure_api.personnel.search("Roddy Piper".split())
```

### Find a person by custom field

```python
import acslib
from acslib.ccure.search import PersonnelFilter, FUZZ

ccure_api = acslib.CcureAPI()
search_filter = PersonnelFilter(lookups={"Text1": FUZZ})
response = ccure_api.personnel.search(["PER0892347"], search_filter=search_filter)
```

### Find a Clearance by name

```python
import acslib

ccure_api = acslib.CcureAPI()
response = ccure_api.clearance.search(["suite", "door"])
```

### Find a Clearance by other field

```python
import acslib
from acslib.ccure.search import ClearanceFilter, NFUZZ

# search by ObjectID
ccure_api = acslib.CcureAPI()
search_filter = ClearanceFilter(lookups={"ObjectID": NFUZZ})
response = ccure_api.clearance.search([8897], search_filter=search_filter)
```

### Find all credentials

```python
import acslib

ccure_api = acs.CcureAPI()
response = ccure_api.credential.search()
```

### Find a credential by name

```python
import acslib

# fuzzy search by name
ccure_api = acslib.CcureAPI()
response = ccure_api.credential.search(["charles", "barkley"])
```

### Find a credential by other field

```python
import acslib
from acslib.ccure.search import CredentialFilter, NFUZZ

# search by ObjectID
ccure_api = acslib.CcureAPI()
search_filter = CredentialFilter(lookups={"ObjectID": NFUZZ})
response = ccure_api.credential.search([5001], search_filter=search_filter)
```

### Update a credential

```python
import acslib

# update CardInt1 for the credential with ObjectID 5001
ccure_api = acslib.CcureAPI()
response = ccure_api.credential.update(5001, {"CardInt1": 12345})
```

