
Product
Introducing Socket Fix for Safe, Automated Dependency Upgrades
Automatically fix and test dependency updates with socket fix—a new CLI tool that turns CVE alerts into safe, automated upgrades.
Package containing Pydantic models representing the entities used in Telescope backend systems. The source of truth for these types lives here.
See Deployment for instructions on how to publish a new version of this package.
$ pip install telescope-sdk
To construct an entity (e.g. Person) you can use the constructor (please note Pydantic only accepts keyword arguments):
from telescope_sdk import Person
person = Person(
id="123",
first_name="John Doe",
...
)
Or, to construct from a Python dictionary object:
person = Person.model_validate({
"id": "123",
"first_name": "John Doe",
...
})
If you are mapping from PDL types, use the from_pdl
method:
person = Person.from_pdl({
"id": "123",
"firstName": "John Doe",
...
})
To make changes to this package clone the repo and follow the steps below. Please ensure that any changes to the code base are synced with the documentation linked above.
First set up a virtual environment to isolate dependencies. You can do this in many ways but as an example:
$ pyenv virtualenv 3.10.0 <chosen-virtualenv-name>
$ pyenv activate <chosen-virtualenv-name>
Note this codebase takes advantage of features from Python 3.10+ therefore you may run into errors if you attempt to use an earlier Python version.
This project relies on Poetry for dependency management. To install Poetry follow the instructions here (recommend using pipx to install Poetry globally but manage in virtualenv).
Now ensure you have Make on your machine then run
$ make install
This will install the package and its dependencies in editable mode.
To run tests locally, run the following command:
$ make test
To run linting locally, run the following command:
$ make lint
A new package version is published to PyPI whenever a new release is created on GitHub. To create a new release follow
the following steps, from the master
branch:
pyproject.toml
to the new version number (use semantic versioning).pyproject.toml
.On pushes to the master
branch, the sandbox-deploy
job will run and publish a new version of the package to
TestPyPI. This is useful for testing changes to the package before publishing to PyPI.
FAQs
Telescope Python SDK
We found that telescope-sdk demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Automatically fix and test dependency updates with socket fix—a new CLI tool that turns CVE alerts into safe, automated upgrades.
Security News
CISA denies CVE funding issues amid backlash over a new CVE foundation formed by board members, raising concerns about transparency and program governance.
Product
We’re excited to announce a powerful new capability in Socket: historical data and enhanced analytics.