Skip to main content

Python library for reporting metrics to Atlas.

Project description

Build Status

Introduction

Python port of the Spectator library for Java.

See the Spectator documentation for an overview of core concepts and details on usage.

Supports Python >= 2.7, with Python >= 3.6 recommended.

Local Development

  • Install pyenv, possibly with Homebrew.
  • Install Python versions: 2.7, 3.6, 3.7, and 3.8. Enable all versions globally.
  • Make changes and add tests.
  • tox

Release Process

  1. Pre-Requisites.

    1. Install packaging tools.

       pip3 install setuptools wheel twine
      
    2. Configure PyPI username.

       cat >~/.pypirc <<EOF
       [distutils]
       index-servers = pypi
      
       [pypi]
       repository: https://pypi.python.org/pypi
       username: $PYPI_USERNAME
       EOF
      
  2. Bump the version number in setup.py.

  3. Tag the repo and write release notes. The goal is for the releases page to be readable.

    1. Clone the upstream project.

    2. Create a new tag.

       git tag v0.1.X
      
    3. Push the tags to the origin.

       git push origin --tags
      
    4. Project > Releases > Tags > Select Tag > Create Release

       Primary changes:
      
       - #<PR number>, <short description>.
      
       A comprehensive list of changes can be found in the commit log: https://github.com/Netflix/spectator-py/compare/v0.1.<N-1>...v0.1.<N>
      
  4. On your local machine, checkout the tag and run the following command, which will build the package and upload it to PyPI.

     git checkout $TAG
     python3.6 setup.py sdist bdist_wheel
     twine check dist/*
     twine upload dist/*
    

Example release commits:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for netflix-spectator-py, version 0.1.13
Filename, size File type Python version Upload date Hashes
Filename, size netflix_spectator_py-0.1.13-py2.py3-none-any.whl (18.3 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size netflix-spectator-py-0.1.13.tar.gz (16.0 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page