Metadata-Version: 2.1
Name: namely
Version: 0.0.3
Summary: Namely Python Client
Home-page: https://github.com/VadymKhodak/namely
Author: VadymKhodak
Author-email: vaddimart@gmail.com
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Classifier: License :: OSI Approved :: MIT License
Requires-Dist: requests==2.25.1
Requires-Dist: retrying==1.3.3
Project-URL: Documentation, https://namely.readthedocs.io/en/latest/

# namely

Non-official Python client for [Namely](https://www.namely.com)

Learn more about Namely API [here](https://developers.namely.com/1.0/getting-started/introduction)

## Installation

```bash
pip install namely
```

## Get started

```python
# Import Namely API Client
from namely import Client

# Initialise Namely API Client
client = Client("https://<your-domain>.namely.com/api/v1/", "<your-namely-api-token>")

# Get all profiles
get_all = client.profiles.get_all(multi_threading=False)

# Get profile by Namely id
person = client.profiles.get("<person-namely-id>")

# Get my Namely profile
me = client.profiles.get_me()

# Get all profiles by filters
mikes = client.profiles.filter(first_name="Mike")

# Update profile by Namely id
profile_to_update = {"user_status": "inactive"}
updated_profile = client.profiles.update("<person-namely-id>", profile_to_update)

# Create Namely profile
new_profile = {
        "first_name": "John",
        "last_name": "Smith",
        "user_status": "active",
        "start_date": "2019-01-01",
        "email": "work@email.com"
        }
created_profile = client.profiles.create(new_profile)

```

## License
[The MIT License](/LICENSE)

