Skip to main content

Synapse reporting.

Project description

Synapse Reporting

Utilities for reporting on Synapse.



pip install syn-reports


Environment Variables

No configuration is necessary if using environment variables or the default synapse config file. For user/pass, set:


For auth token, set:


For Synapse Config file, have a valid config file in: ~/.synapseConfig Or, have the environment variable set: SYNAPSE_CONFIG_FILE=

Command Line Arguments

  -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: syn-reports [-h]

Synapse Reports

optional arguments:
  -h, --help            show this help message and exit

                        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.
                        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.


  • Create and activate a virtual environment:
  • Rename .env-template to .env and set each of the variables.
  • Run the tests: make test

Project details

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)

Uploaded source

Built Distribution

syn_reports-0.0.18-py2.py3-none-any.whl (30.8 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page