Package Health Score

49 / 100

security
Security review needed
popularity
Recognized
maintenance
Inactive
community
Sustainable

Explore Similar Packages

Popularity

Recognized

GitHub Stars: 213
Forks: 112
Contributors: 7

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package WooCommerce, we found that it has been starred 213 times.

Security

Security review needed

Security and license risk for latest version

Release Date: Mar 13, 2021
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
1
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

MIT

Security Policy

We found a way for you to contribute to the project! Looks like WooCommerce is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 24
Open PR: 8
Last Release: 4 years ago
Last Commit: 4 years ago

Further analysis of the maintenance status of WooCommerce based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for WooCommerce is that it hasn't seen any new versions released to PyPI in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Sustainable

Readme: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 7
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like WooCommerce is missing a Code of Conduct.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: >=3.6

Age: 9 years
Latest Release: 4 years ago
Dependencies: 1 Direct / 5 Total
Versions: 13
Maintainers: 1
Wheels: OS Independent

Readme

WooCommerce API - Python Client

A Python wrapper for the WooCommerce REST API. Easily interact with the WooCommerce REST API using this library.

Installation

pip install woocommerce

Getting started

Generate API credentials (Consumer Key & Consumer Secret) following this instructions .

Check out the WooCommerce API endpoints and data that can be manipulated in .

Setup

from woocommerce import API

wcapi = API(
    url="http://example.com",
    consumer_key="ck_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    consumer_secret="cs_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    version="wc/v3"
)

Options

Option	Type	Required	Description
`url`	`string`	yes	Your Store URL, example: http://woo.dev/
`consumer_key`	`string`	yes	Your API consumer key
`consumer_secret`	`string`	yes	Your API consumer secret
`version`	`string`	no	API version, default is `wc/v3`
`timeout`	`integer`	no	Connection timeout, default is `5`
`verify_ssl`	`bool`	no	Verify SSL when connect, use this option as `False` when need to test with self-signed certificates
`query_string_auth`	`bool`	no	Force Basic Authentication as query string when `True` and using under HTTPS, default is `False`
`user_agent`	`string`	no	Set a custom User-Agent, default is `WooCommerce-Python-REST-API/3.0.0`
`oauth_timestamp`	`integer`	no	Custom timestamp for requests made with oAuth1.0a
`wp_api`	`bool`	no	Set to `False` in order to use the legacy WooCommerce API (deprecated)

Methods

Params	Type	Description
`endpoint`	`string`	WooCommerce API endpoint, example: `customers` or `order/12`
`data`	`dictionary`	Data that will be converted to JSON
`**kwargs`	`dictionary`	Accepts `params`, also other Requests arguments

GET

.get(endpoint, **kwargs)

POST

.post(endpoint, data, **kwargs)

PUT

.put(endpoint, data), **kwargs

DELETE

.delete(endpoint, **kwargs)

OPTIONS

.options(endpoint, **kwargs)

Response

All methods will return Response object.

Example of returned data:

&gt;&gt;&gt; r = wcapi.get("products")
&gt;&gt;&gt; r.status_code
200
&gt;&gt;&gt; r.headers['content-type']
'application/json; charset=UTF-8'
&gt;&gt;&gt; r.encoding
'UTF-8'
&gt;&gt;&gt; r.text
u'{"products":[{"title":"Flying Ninja","id":70,...' // Json text
&gt;&gt;&gt; r.json()
{u'products': [{u'sold_individually': False,... // Dictionary data

Request with params example

from woocommerce import API

wcapi = API(
    url="http://example.com",
    consumer_key="ck_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    consumer_secret="cs_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    version="wc/v3"
)

# Force delete example.
print(wcapi.delete("products/100", params={"force": True}).json())

# Query example.
print(wcapi.get("products", params={"per_page": 20}).json())

Changelog

See CHANGELOG.md.

WooCommerce dependencies

requests

FAQs

What is WooCommerce?

A Python wrapper for the WooCommerce REST API. Visit Snyk Advisor to see a full health score report for WooCommerce, including popularity, security, maintenance & community analysis.

Is WooCommerce popular?

The python package WooCommerce receives a total of 21,831 weekly downloads. As such, WooCommerce popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is WooCommerce well maintained?

We found indications that WooCommerce is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is WooCommerce safe to use?

While scanning the latest version of WooCommerce, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 13 November-2024, at 09:43 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP