Skip to main content
# CodeStats

[![Build Status](https://travis-ci.org/NiekKeijzer/CodeStats.svg?branch=master)](https://travis-ci.org/NiekKeijzer/CodeStats)
[![Coverage Status](https://coveralls.io/repos/github/NiekKeijzer/CodeStats/badge.svg?branch=master)](https://coveralls.io/github/NiekKeijzer/CodeStats?branch=master)

A simple wrapper around the [Code::Stats][1] API. Currently this wrapper only supports getting information from the API
and presenting it in a 'Pythonic' way. Posting new stats to the API is a feature that might be added in the future.

## Sync Usage

```python
from codestats.api import User

user = User('niekkeijzer')
```

Or if you prefer to call the `load` method yourself, you can disable `auto_load`.

```python
from codestats.api import User

user = User('niekkeijzer', auto_load=False)
```

You can also get a single language or machine instance by using the `get` method.

```python
from codestats.api import User
from codestats.bases import Language

user = User('niekkeijzer')
python = user.get('Python', Language)
```

Or by using the shorthands

```python
from codestats.api import User

user = User('niekkeijzer')
python = user.get_language('python')
work_pc = user.get_machine('work')
```

## Async usage

As of version 1.1.0 the library can be used in a non blocking manner as well. For this [asyncio][3] and [aiohttp][4]
should be installed. The `User` object should be loaded differently, however the other methods work the same as the
synchronous object.

```python
from codestats.async_api import User

async def load_user(name):
async with User(name) as user:
print(user)
```

Or without auto loading enabled.

```python
from codestats.async_api import User

async def load_user(name):
async with User(name, auto_load=False) as user:
await user.load()
```

`User`, `Machine` and `Language` instances each have properties to calculate the level based on the current level as well as
the progress to the next level. The formula used to calculate these values is the same as is used by the official
[API][2].

## License

This code is released under the MIT license, see the included LICENSE file for more information.


[1]: https://codestats.net/
[2]: https://github.com/code-stats/code-stats/blob/master/lib/code_stats/xp_calculator.ex
[3]: https://asyncio.readthedocs.io/en/latest/
[4]: http://aiohttp.readthedocs.io

Metadata

Release files for CodeStats 1.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for CodeStats 1.1.0
File Size Uploaded Provenance
CodeStats-1.1.0.tar.gz 4.8 kB Without provenance Details

Release files / CodeStats-1.1.0.tar.gz

Download URL CodeStats-1.1.0.tar.gz
Size 4.8 kB
Tags Source
SHA-256 checksum
How to use checksums
bc85d8faf4e3eabd6e3bab9c9e6e7d5d9bd234f09122782e9869f6db09a44ddd
BLAKE2b-256 checksum
How to use checksums
d81bd0a917d83a0d5d5755fa98a798089ade1895c040d9df4e5120924f8d8258
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for CodeStats 1.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page