Synapse reporting.
Project description
Synapse Reporting
Utilities for reporting on Synapse.
Dependencies
- Python3.10+
- A Synapse account with an auth token. API to authenticate.
Install
pip install syn-reports
Configuration
Environment Variables
No configuration is necessary if using environment variables or the default synapse config file. For user/pass, set:
SYNAPSE_USERNAME=
SYNAPSE_PASSWORD=
For auth token, set:
SYNAPSE_AUTH_TOKEN=
For Synapse Config file, have a valid config file in:
~/.synapseConfig
Or, have the environment variable set:
SYNAPSE_CONFIG_FILE=
Command Line Arguments
options:
-u USERNAME, --username USERNAME
Synapse username.
-p PASSWORD, --password PASSWORD
Synapse password.
--auth-token AUTH_TOKEN
Synapse auth token.
--synapse-config SYNAPSE_CONFIG
Path to Synapse configuration file.
Usage
usage: syn-reports [-h]
{benefactor-permissions,entity-permissions,user-project-access,user-teams,team-members}
...
Synapse Reports
optional arguments:
-h, --help show this help message and exit
Commands:
{benefactor-permissions,entity-permissions,user-project-access,user-teams,team-members}
benefactor-permissions
Report the unique permissions on a Synapse entity and
all its child entities.
entity-permissions Report the permissions of each user and team on a
Synapse entity.
user-project-access
Report the projects a user has access to. NOTE: Only
public projects or projects the user executing this
script has access to will be reported.
user-teams Report the teams a user is a member of.
team-members Report the members on a team.
Development Setup
pipenv --python 3.11
pipenv shell
make pip_install
make build
make install_local
See Makefile for all commands.
Testing
- Create and activate a virtual environment:
- Rename .env-template to .env and set each of the variables.
- Run the tests:
make test
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
syn-reports-0.0.18.tar.gz
(20.3 kB
view hashes)
Built Distribution
Close
Hashes for syn_reports-0.0.18-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 444c97608d1c6dce80926cc8c3445520803c8907fe04ddf21ab00b0c686572af |
|
MD5 | 14414c53d5d33f75e6f9a147bd97cb4a |
|
BLAKE2b-256 | 484220fb6a2b14b3894443e9dc4d6c531a6dd6ac4fbdd9b3e8dbd2b78cbe8d03 |