carbon-txt

v0.0.11

A command line tool containing a validator for carbon.txt files, by the Green Web Foundation For more information about how to use this package see README

Latest version published 24 days ago

License: BSD-3-Clause

PyPI

GitHub

Package Health Score

75 / 100

security
No known security issues
popularity
Small
maintenance
Healthy
community
Sustainable

Explore Similar Packages

to
46

Popularity

Small

GitHub Stars: 2.9K
Forks: 86
Contributors: 30

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package carbon-txt, we found that it has been starred 2,902 times.

Security

No known security issues

Security and license risk for latest version

Release Date: Nov 25, 2024
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
0
M
0
L

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

License

BSD-3-Clause

Security Policy

We found a way for you to contribute to the project! Looks like carbon-txt 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

Healthy

Commit Frequency

Open Issues: 32
Open PR: 11
Last Release: 24 days ago
Last Commit: 27 days ago

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

We found that carbon-txt demonstrates a positive version release cadence with at least one new version released in the past 3 months.

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: 30
Funding: Yes

With more than 10 contributors for the carbon-txt repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like carbon-txt 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.11

Age: 1 month
Latest Release: 24 days ago
Dependencies: 0 Direct
Versions: 8
Maintainers: 0
Wheels: OS Independent

Readme

Carbon.txt validator

This validator reads carbon.txt files, and validates them against a spec defined on http://carbontxt.org.

Usage

With the CLI

Run a validation against a given domain, or file, say if the file is valid TOML, and it confirms to the carbon.txt spec.

The following commands assume you are working in a virtual environment:

# parse the carbon.txt file on default paths on some-domain.com
carbon-txt validate domain some-domain.com

# parse a remote file available at https://somedomain.com/path-to-carbon.txt
carbon-txt validate file https://somedomain.com/path-to-carbon.txt

# parse a local file ./path-to-file.com
carbon-txt validate file ./path-to-file.com

# pipe the contents of a file into the file validation command as part of a pipeline
cat ./path-to-file.com | carbontxt validate file

Using UV

If you are not using virtual environments directly, you can use it with uv, which is the recommended way to run the project.

Add carbon-txt to a project with uv add:

uv add carbon-txt

You can now run the command line tool with uv run carbon-txt

Running outside a project

If you have uv installed, you can run the command line tool like so:

# check a file
uv tool run carbon-txt validate ./path/to/file

# run a server
uv tool run carbon-txt serve

This will download the latest published version from pypi and run the corresponding CLI command

With the HTTP API

You can also validate carbon.txt files sent over an HTTP API.

# run the carbon-txt validator as a server using the default django server. Not for production
carbon-txt serve

For production, Granian, a performant webserver is bundled. Pass the flag --server granian to use it.

# run the carbon-txt validator as a server using the production granian server
carbon-txt serve --server granian

FAQs

What is carbon-txt?

A command line tool containing a validator for carbon.txt files, by the Green Web Foundation. Visit Snyk Advisor to see a full health score report for carbon-txt, including popularity, security, maintenance & community analysis.

Is carbon-txt popular?

We’re still processing downloads data for the python package carbon-txt. Visit the popularity section on Snyk Advisor to see the full popularity analysis.

Is carbon-txt well maintained?

We found that carbon-txt demonstrated a healthy version release cadence and project activity. It has a community of 30 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is carbon-txt safe to use?

The python package carbon-txt was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 16 December-2024, at 23:17 (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