Okapi
=====

Python Library to send API info to Storage Server


Okapi setup 
===========
In an existing project you should at least modify the following files:


requirements/base.txt
---------------------
Add the following requirement to the project's settings. It won't be needed to
add ``requests`` if the project is already using it.
``requests`` version should be >= 2.2.11:

.. code-block:: python

    okapi==X.Y.Z


settings.py
-----------
Add the following configuration to the project's settings:

.. code-block:: python    

    ########## OKAPI CONFIGURATION
    OKAPI_PROJECT = 'your-project-name'

    OKAPI_URI = None
    if settings.has_section('okapi'):
        OKAPI_URI = 'mongodb://{0},{1},{2}/{3}?replicaSet={4}'.format(

            settings.get('okapi', 'host0'),
            settings.get('okapi', 'host1'),
            settings.get('okapi', 'host2'),
            settings.get('okapi', 'name'),
            settings.get('okapi', 'replica'),
        )

    ########## END OKAPI CONFIGURATION

Note that if the project is already using *MongoDB*, you shouldn't store Okapi's
data into the same database. Okapi creates collections dynamically and could
conflict with your the  project's.


Initialization
--------------
Initialize Okapi in the ``models.py`` file of a basic application of the project.
This way Okapi will be imported at startup time:

.. code-block:: python

    import requests    
    from django.conf import settings    

    from okapi.api import Api

    project_name = getattr(settings, 'OKAPI_PROJECT')
    mongodb_uri = getattr(settings, 'MONGODB_URI')
    okapi_client = Api(project_name, requests, mongodb_uri)


Usage
-----
Once initialized you can use Okapi wherever you use ``requests`` library.
Think of Okapi as if you were using ``requests`` because they both have the same
API.

Requests documentation: http://docs.python-requests.org/en/latest/


Activating/deactivating okapi in your project
---------------------------------------------
In the file ``settings/base.py`` under the ``OKAPI CONFIGURATION`` section, you 
can add a boolean setting in order to enable/disable okapi for your project. It 
could be interesting to have it enabled in QA or staging environment and after
it has been properly tested, activate it also in production.

You can have a section into ``your-project-name/settings/dev.py``: 

.. code-block:: python

    ########## OKAPI CONFIGURATION
    OKAPI_ENABLED = True
    ########## END OKAPI CONFIGURATION

Another one into ``your-project-name/settings/production.py``: 

.. code-block:: python    

    ########## OKAPI CONFIGURATION
    OKAPI_ENABLED = False
    ########## END OKAPI CONFIGURATION

And so on. Note that ``get_custom_setting`` is a wrapper around ``getattr``. 
Then you could initialize it conditionally as shown below:

.. code-block:: python

    http_lib = requests
    if (get_custom_setting('OKAPI_ENABLED') and okapi_uri is not None):
        project_name = get_custom_setting('OKAPI_PROJECT', required=True)
        okapi_uri = get_custom_setting('OKAPI_URI', required=True)
        okapi_client = Api(project_name, requests, okapi_uri)
        http_lib = okapi_client



0.12.0 (2015-04-01)
-------------------
- New Features:

  - Method `get_mongodb_client` to get a MongoDB connection client.

- Bugfixes:

  - None

- Incompatible changes:

  - `Okapi.__init__` has changed to have a new mandatory `db` parameter.
   Parameters `mongodb_uri` and `connect_timeout_ms` have been removed.

0.11.0 (2014-12-29)
-------------------
- New Features:

  - Changed blank space to a T letter as indicator of the beginning of the time 
    element to be more iso-friendly:
    http://www.ecma-international.org/ecma-262/5.1/#sec-15.9.1.15

0.10.0 (2014-11-11)
-------------------
- New Features:

  - Don't hardcode the name of the database but expect it to be in
    the mongodb_uri parameter.

0.9.0 (2014-10-16)
------------------
- New Features:

  - Decouple okapi from requests so that any library following requests 
    interface can be used. This introduces a backward incompatible change
    because now the __init__ method for okapi Api class requires a new
    argument

0.8.0 (2014-09-26)
------------------
- New features:

  - Use one collection per project instead of saving all projects in the same collection
  - Add a time_bucket attribute to make time based queries faster

0.7.1 (2014-07-28)
----------------
- Bug Fixes:

	-Make sure to raise the exception if an error occurs so the user know 
	exactly what is happening instead of code crashing

Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 4-6

okapi

alejandro.garcia

gball

reemymaria

Inherit

Block

Ignore

Monitor

Warn

License

Maintenance

Miscellaneous

Quality

Supply chain risk

Vulnerability

When alerts are associated with multiple artifacts, the priority score is based on the artifact with the highest priority score.

Legal

Operational

Security

Admins only

Organization members

Dashboard

Grouping: Directs

Grouping: None

Artifact: <code>{{- fullArtifactDisplayName}}</code>

Dependency tree

<upgradeLink>Upgrade</upgradeLink> to access this feature

Achievements

Why Socket?

Blog

Customer Stories

Languages

Impersonation Mode Active

Update your browser to the latest version for the best experience.

Your web browser is outdated

Use another browser for the best experience.

Your web browser is unsupported

{{count, number}} commits last two months

{{count, number}} critical severity alert

{{count, number}} critical severity alerts

{{count, number}} dependency vulnerability

{{count, number}} dependency vulnerabilities

{{count, number}} development dependencies

{{count, number}} transitive dependencies

{{count, number}} version published last month

{{count, number}} versions published last month

{{count, number}} version published in last two months

{{count, number}} versions published in last two months

{{count, number}} version published last week

{{count, number}} versions published last week

{{count, number}} version published last year

{{count, number}} versions published last year

Socket undergoes annual SOC2 Type II audits. Socket customers can request a copy of the full SOC2 Type II report.

Allows organization owners and admins to access detailed records of actions taken by members of their organization, complete with timestamps.

Prevent compromised packages from infiltrating your supply chain by monitoring for changes in real-time.

Join our Discord community to get help from Socket engineers and other Socket users.

Compare millions of open source packages on socket.dev

Detect malicious code and risky behavior (e.g. network) in your dependencies using "deep package inspection"

All data is encrypted in transit and at rest using industry standard encryption algorithms.

Get a dedicated Socket account manager and access to Socket's Customer Success team.

Get dedicated support from Socket engineers via email and Slack.

"Shift left" with the Socket Chrome extension and give intervene early, before developers choose risky or low quality dependencies.

Catch developers using risky dependencies and give them a "speed bump" to encourage good behavior

Install the Socket GitHub app to receive real-time dependency scanning and reports with every pull request.

Integrate Socket into your GitHub SCM to prevent risky dependencies from being installed.

Socket scans for vulnerabilities in your dependencies, including CVEs, security advisories, and more.

Socket supports dependencies in many languages, with most popular ecosystems coming in 2024. We've got you covered no matter what languages you use.

Enforce license policies across your organization

Receive a Microsoft Teams message to the channel of your choice anytime Socket runs a new analysis, has a new finding, or a policy has changed.

Get help migrating from Socket's free plan to Socket's paid plans.

Run Socket on-premises or in your own cloud environment.

Query for any dependency (at any version) across your entire organization

Integrate Socket into your CI/CD pipeline to prevent risky dependencies from being deployed to production.

Analyze an entire project to find supply chain risks

Tag projects to organize and filter your projects

Restrict access based on the roles of individual users within an organization.

Receive a Slack message to the channel of your choice anytime Socket runs a new analysis, has a new finding, or a policy has changed.

Socket is SOC2 Type II compliant and undergoes annual audits.

The Socket CLI allows teams to prevent risky dependencies from being installed, and to get dependency insights from the command line.

Socket supports SAML SSO for single sign-on and identity management.

Integrate Socket into your VS Code IDE to prevent risky dependencies from being installed.

Get a POST request anytime Socket runs a new analysis, has a new finding, or a policy has changed.

Socket will analyze your SBOMs up to a maximum number of dependencies.

API that allows you to analyze a project, lookup package scores and alerts, and more.

Create API tokens to authenticate with the Socket API and CLI.

The number of developers in your team. A developer is someone who made a commit to your organization's repositories scanned by Socket in the past month.

Use Socket to protect your private repositories.

Socket is always free for open source projects.

Socket retains all reporting data for 3 months, 1 year, or a custom term of your choice.

Access the threat feed that powers Socket.

Unlimited scale, self-hosting, and priority support for large teams.

For open-source projects, individuals, and small teams.

For growing teams with enhanced scale, security, and support.

This is a legacy plan that is no longer available for new customers. Upgrade to our Team or Enterprise plans for enhanced features and support.

There is a package with a similar name that is downloaded much more often.

There are packages with similar names that are downloaded much more often.

This may not be the package you want!

Instance

Alert Locations

Package

Readme not found for selected version

Provide a detailed description of the threat...

Socket fights vulnerabilities and provides visibility, defense-in-depth, and proactive supply chain protection for JavaScript, Python, and Go dependencies.

Socket - Secure your dependencies. Ship with confidence.

Welcome to Socket

{{count, number}} maintainer

{{count, number}} maintainers

{{- packageName}} - {{ecosystem}} Package Maintainers

{{packageDescription}}Version: {{versionString}} was published by {{publisherName}}. Start using Socket to analyze {{- packageName}} and its dependencies to secure your app from supply chain attacks.

We could not scan this package. Some page functionalities have been disabled

Source code not available

Sorry, it seems this package was removed from the registry

Package was removed

This package version has been unpublished, mostly likely due to security reasons

okapi - pypi Package Maintainers