tpm

KO | EN

gitlite — search

#hacktoberfest #react #ai #llm #golang #android #machine-learning #rust #deep-learning #docker #macos #kubernetes #mcp #openai

(★ 14)

Python Module for TeamPasswordManager API

tpm 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# tpm.py

> Modern Python SDK groundwork for TeamPasswordManager with safer API boundaries and maintainable packaging.

[![CI](https://github.com/peshay/tpm/actions/workflows/ci.yml/badge.svg)](https://github.com/peshay/tpm/actions/workflows/ci.yml)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=peshay_tpm&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=peshay_tpm)
[![PyPI version](https://img.shields.io/pypi/v/tpm)](https://pypi.org/project/tpm/)
[![Python version](https://img.shields.io/pypi/pyversions/tpm)](https://pypi.org/project/tpm/)
[![License](https://img.shields.io/github/license/peshay/tpm)](https://raw.githubusercontent.com/peshay/tpm/master/LICENSE)

[![Support via bunq](https://img.shields.io/badge/Support-bunq-00A1E0?style=flat-square&logo=bunq&logoColor=white)](https://bunq.me/ahuservices?description=tpm-maintenance-support)

A Python Module for the [TeamPasswordManager API](http://teampasswordmanager.com/docs/api/)

Requires: requests

## Install tpm.py

You can install the tpm module via pip

pip install tpm

## How to Use

This is an example how you can use it in a python script

```python
#! /usr/bin/env python
import tpm
# create a object for the connection settings
URL = "https://mypasswordmanager.example.com"
USER = 'example-user'
PASS = 'EXAMPLE_PASSWORD'
tpmconn = tpm.TpmApiv5(URL, username=USER, password=PASS)

# get a dictionary for all password entries
data = tpmconn.list_passwords()
# show all names from the password entries
for item in data:
    print (item.get('name'))
```

You can also use Private/Public Key authentication

```python
#! /usr/bin/env python
import tpm
# create a object for the connection settings
URL = "https://mypasswordmanager.example.com"
pubkey = 'EXAMPLE_PUBLIC_KEY'
privkey = 'EXAMPLE_PRIVATE_KEY'
tpmconn = tpm.TpmApiv5(URL, private_key=privkey, public_key=pubkey)

# get a dictionary for all password entries
data = tpmconn.list_passwords()
# show all names from the password entries
for item in data:
    print (item.get('name'))
```

If you always want to unlock entries that are locked, you can specify an unlock reason

```python
tpmconn = tpm.TpmApiv5(URL, username=USER, password=PASS, unlock_reason="Because I can!")
```

### TLS certificate verification

TLS certificates are verified by default (`verify=True`). To connect to a server
with a self-signed certificate you can disable verification or point to a custom
CA bundle:

```python
# disable verification (not recommended)
tpmconn = tpm.TpmApiv5(URL, username=USER, password=PASS, verify=False)

# or verify against a custom CA bundle
tpmconn = tpm.TpmApiv5(URL, username=USER, password=PASS, verify="/path/to/ca-bundle.pem")
```

## API v6

Use `tpm.TpmApiv6` to talk to the v6 API. It inherits every function from the
previous versions and adds the endpoints introduced in v6 (see the
[Functions explained](#functions-explained) section, marked `(since v6)`):

```python
tpmconn = tpm.TpmApiv6(URL, username=USER, password=PASS)
```

### Page size

Since v6 you can set the page size for paginated requests via the `X-Page-Size`
header. Pass `page_size` (an integer between 5 and 1000) when creating the
client:

```python
tpmconn = tpm.TpmApiv6(URL, username=USER, password=PASS, page_size=100)
```

## Development artifact guard

This repository uses pre-commit to keep public artifacts safe to publish.
Install the hook once after cloning:

```sh
python3 -m pip install pre-commit
pre-commit install --install-hooks
```

Before opening a PR, run:

```sh
pre-commit run --all-files
```

The guard blocks accidental literal backslash-n text where real line breaks belong, local machine paths, internal workflow details, and obvious secret or auth-token values. Replace real values with placeholders or environment-variable references before publishing.

## Logging

Every function call leads to a at least a logging message.
If you want to log all your script does, you can do it like this:

```python
import logging

# set log file and log level
logfile = 'MyLogFile.log'
loglevel = logging.INFO
logformat = '%(asctime)s - %(levelname)s - %(message)s'

logging.basicConfig(filename=logfile, level=loglevel, format=logformat)
# If you don't want the requests and urllib3 module to log too much
logging.getLogger("requests").setLevel(logging.WARNING)
logging.getLogger("urllib3").setLevel(logging.WARNING)
```

## Functions explained

### All Functions are also explained at the API documentation

---

### [API Projects](http://teampasswordmanager.com/docs/api-projects)

#### [List Projects](http://teampasswordmanager.com/docs/api-projects/#list_projects)

list_projects()

list_projects_archived()

list_projects_favorite()

list_projects_search(searchstring)

#### (since v4) [List Subprojects](http://teampasswordmanager.com/docs/api-projects/#list_subprojects)

list_subprojects(ID)

list_subprojects_action(ID, action)

#### [Show Project](http://teampasswordmanager.com/docs/api-projects/#show_project)

show_project(ID)

#### [List Passwords of Project](http://teampasswordmanager.com/docs/api-projects/#list_pwds_prj)

list_passwords_of_project(ID)

#### [List User Access on Project](http://teampasswordmanager.com/docs/api-projects/#list_users_prj)

list_user_access_on_project(ID)

#### [Create Project](http://teampasswordmanager.com/docs/api-projects/#create_project)

create_project(data)

#### [Update Project](http://teampasswordmanager.com/docs/api-projects/#update_project)

update_project(ID, data)

#### [Change Parent of Project](http://teampasswordmanager.com/docs/api-projects/#change_parent)

change_parent_of_project(ID, NewParentID)

#### [Update Security of Project](http://teampasswordmanager.com/docs/api-projects/#update_project_security)

update_security_of_project(ID, data)

#### [Archive Project](http://teampasswordmanager.com/docs/api-projects/#arch_unarch_project)

archive_project(ID)

#### [Unarchive Project](http://teampasswordmanager.com/docs/api-projects/#arch_unarch_project)

unarchive_project(ID)

#### [Delete Project](http://teampasswordmanager.com/docs/api-projects/#delete_project)

delete_project(ID)

### [API Passwords](http://teampasswordmanager.com/docs/api-passwords)

#### [List Passwords](http://teampasswordmanager.com/docs/api-passwords/#list_passwords)

list_passwords()

list_passwords_archived()

list_passwords_favorite()

list_passwords_search(searchstring)

#### [Show Password](http://teampasswordmanager.com/docs/api-passwords/#show_password)

show_password(ID)

#### [List User Access on Password](http://teampasswordmanager.com/docs/api-passwords/#list_users_pwd)

list_user_access_on_password(ID)

#### [Create Password](http://teampasswordmanager.com/docs/api-passwords/#create_password)

create_password(data)

#### [Update Password](http://teampasswordmanager.com/docs/api-passwords/#update_password)

update_password(ID, data)

#### [Update Security of Password](http://teampasswordmanager.com/docs/api-passwords/#update_security_password)

update_security_of_password(ID, data)

#### [Update Custom Fields of Password](http://teampasswordmanager.com/docs/api-passwords/#update_cf_password)

update_custom_fields_of_password(ID, data)

#### [Delete Password](http://teampasswordmanager.com/docs/api-passwords/#delete_password)

delete_password(ID)

#### [Lock Password](http://teampasswordmanager.com/docs/api-passwords/#lock_password)

lock_password(ID)

#### [Unlock Password](http://teampasswordmanager.com/docs/api-passwords/#unlock_password)

unlock_password(ID)

#### (since v5) [Archive Password](http://teampasswordmanager.com/docs/api-passwords/#arch_unarch_password)

archive_password(ID)

#### (since v5) [Unarchive Password](http://teampasswordmanager.com/docs/api-passwords/#arch_unarch_password)

unarchive_password(ID)

#### (since v5) [Move Password](http://teampasswordmanager.com/docs/api-passwords/#move_password)

move_password(ID, PROJECT_ID)

### [API MyPasswords](http://teampasswordmanager.com/docs/api-my-passwords)

#### (since v6) [List Archived MyPasswords](http://teampasswordmanager.com/docs/api-my-passwords/#list_passwords)

list_mypasswords_archived()

#### (since v6) [List Favorite MyPasswords](http://teampasswordmanager.com/docs/api-my-passwords/#list_passwords)

list_mypasswords_favorite()

#### [List MyPasswords](http://teampasswordmanager.com/docs/api-my-passwords/#list_passwords)

list_mypasswords()

list_mypasswords_search(searchstring)

#### [Show MyPassword](http://teampasswordmanager.com/docs/api-my-passwords/#show_password)

show_mypassword(ID)

#### [Create MyPassword](http://teampasswordmanager.com/docs/api-my-passwords/#create_password)

create_mypassword(data)

#### [Update MyPassword](http://teampasswordmanager.com/docs/api-my-passwords/#update_password)

update_mypassword(ID, data)

#### [Delete MyPassword](http://teampasswordmanager.com/docs/api-my-passwords/#delete_password)

delete_mypassword(ID)

### [API Favorites](http://teampasswordmanager.com/docs/api-favorites)

#### [Set Favorite Password](http://teampasswordmanager.com/docs/api-favorites/#set_fav)

set_favorite_password(ID)

#### [Unset Favorite Password](http://teampasswordmanager.com/docs/api-favorites/#del_fav)

unset_favorite_password(ID)

#### [Set Favorite Project](http://teampasswordmanager.com/docs/api-favorites/#set_fav)

set_favorite_project(ID)

#### [Unset Favorite Project](http://teampasswordmanager.com/docs/api-favorites/#del_fav)

unset_favorite_project(ID)

> Note: `TpmApiv6` overrides these two to use the v6 endpoint `favorite_projects/{ID}.json` (plural); earlier versions use `favorite_project/{ID}.json`.

#### (since v6) [Set Favorite MyPassword](http://teampasswordmanager.com/docs/api-favorites/#set_fav)

set_favorite_mypassword(ID)

#### (since v6) [Unset Favorite MyPassword](http://teampasswordmanager.com/docs/api-favorites/#del_fav)

unset_favorite_mypassword(ID)

#### [Move MyPassword to a Project](https://teampasswordmanager.com/docs/api-my-passwords/#move_password)

move_mypassword(ID, PROJECT_ID)

### [API Users](http://teampasswordmanager.com/docs/api-users)

#### [List Users](http://teampasswordmanager.com/docs/api-users/#list_users)

list_users()

#### [Show User](http://teampasswordmanager.com/docs/api-users/#show_user)

show_user(ID)

#### (since v6) [List Passwords a User can access](http://teampasswordmanager.com/docs/api-users/)

list_user_passwords(ID)

#### (since v6) [List Projects a User can access](http://teampasswordmanager.com/docs/api-users/)

list_user_projects(ID)

#### [Show Me/Who am I?](http://teampasswordmanager.com/docs/api-users/#show_me)

show_me()
who_am_i()

#### [Create User](http://teampasswordmanager.com/docs/api-users/#create_user)

create_user(data)

#### (since v5) [Create LDAP User](http://teampasswordmanager.com/docs/api-users/#create_user_ldap)

create_user_ldap(data)

#### (since v5) [Create SAML User](http://teampasswordmanager.com/docs/api-users/#create_user_saml)

create_user_saml(data)

#### [Update User](http://teampasswordmanager.com/docs/api-users/#update_user)

update_user(ID, data)

#### [Change User Password](http://teampasswordmanager.com/docs/api-users/#change_password)

change_user_password(ID, data)

#### [Activate User](http://teampasswordmanager.com/docs/api-users/#activate_deactivate)

activate_user(ID)

#### [Deactivate User](http://teampasswordmanager.com/docs/api-users/#activate_deactivate)

deactivate_user(ID)

#### [Convert User to LDAP](http://teampasswordmanager.com/docs/api-users/#convert_to_ldap)

convert_user_to_ldap(ID, DN)
convert_ldap_user_to_normal(ID)

#### (since v5) [Convert User to LDAP](http://teampasswordmanager.com/docs/api-users/#convert_to_ldap)

convert_user_to_ldap(ID, DN, SERVER_ID)

#### (since v5) [Convert User to SAML](http://teampasswordmanager.com/docs/api-users/#convert_to_saml)

convert_user_to_saml(ID)

#### [Delete User](http://teampasswordmanager.com/docs/api-users/#delete_user)

delete_user(ID)

### [API Groups](http://teampasswordmanager.com/docs/api-groups)

#### [List groups](http://teampasswordmanager.com/docs/api-groups/#list_groups)

list_groups()

#### [Show Group](http://teampasswordmanager.com/docs/api-groups/#show_group)

show_group(ID)

#### [Create Group](http://teampasswordmanager.com/docs/api-groups/#create_group)

create_group(data)

#### [Update Group](http://teampasswordmanager.com/docs/api-groups/#update_group)

update_group(ID, data):

#### [Add User to Group](http://teampasswordmanager.com/docs/api-groups/#add_user)

add_user_to_group(GroupID, UserID)

#### [Delete User from Group](http://teampasswordmanager.com/docs/api-groups/#del_user)

delete_user_from_group(GroupID, UserID)

#### [Delete Group](http://teampasswordmanager.com/docs/api-groups/#delete_group)

delete_group(ID)

### [Files](https://teampasswordmanager.com/docs/api-files/)

#### (since v5) [List Files of Project](https://teampasswordmanager.com/docs/api-projects/#list_files)

list_project_files(ID)

#### (since v5) [List Files of Password](http://teampasswordmanager.com/docs/api-passwords/#list_files)

list_password_files(ID)

#### (since v5) [Upload a file to a project](https://teampasswordmanager.com/docs/api-projects/#upload)

upload_project_file(ID, file, notes="optional notes")

#### (since v5) [Upload a file to a password](http://teampasswordmanager.com/docs/api-passwords/#upload)

upload_password_file(ID, file, notes="optional notes")

#### (since v5) [Show info of a file](https://teampasswordmanager.com/docs/api-files/#show_file)

show_file_info(ID)

#### (since v5) [Updates notes of a file](https://teampasswordmanager.com/docs/api-files/#update_file)

update_file_notes(ID, NOTES)

#### (since v5) [Show max upload file size](https://teampasswordmanager.com/docs/api-files/#max_upload_file_size)

max_upload_file_size()

#### (since v5) [Download a file](https://teampasswordmanager.com/docs/api-files/#download_file)

download_file(ID)

#### (since v5) [Delete a file](https://teampasswordmanager.com/docs/api-files/#delete_file)

delete_file(ID)

### [API Password Generator](http://teampasswordmanager.com/docs/api-passwords-generator/)

generate_password()

### [API Version](http://teampasswordmanager.com/docs/api-version/)

get_version()
get_latest_version()
up_to_date()

### (since v6) [API Log](http://teampasswordmanager.com/docs/api-log/)

#### (since v6) [List Log](http://teampasswordmanager.com/docs/api-log/)

list_log()

#### (since v6) [Search Log](http://teampasswordmanager.com/docs/api-log/)

list_log_search(searchstring)

## Governance

- Contribution guide: [CONTRIBUTING.md](CONTRIBUTING.md)
- Security policy: [SECURITY.md](SECURITY.md)
- AI-agent guide: [AGENTS.md](AGENTS.md)
- License: [LICENSE](LICENSE)

## Support

If this Python SDK is useful to you, you can [support its ongoing maintenance via bunq](https://bunq.me/ahuservices?description=tpm-maintenance-support). Support is voluntary and appreciated, but does not create any entitlement to support, features, consulting, an SLA, or invoice-based work.

tpm

tpm 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

tpm

tpm 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README