Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ashitaprasad committed May 11, 2024
1 parent 5072681 commit 5742a46
Showing 1 changed file with 18 additions and 10 deletions.
28 changes: 18 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
[![Discord Server Invite](https://img.shields.io/badge/DISCORD-JOIN%20SERVER-5663F7?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/2s49SCNfyJ)

This project is an participating in GSSoC 2024.

![gssoc-logo-1](https://github.com/foss42/awesome-generative-ai-apis/assets/1382619/670b651a-15d7-4869-a4d1-6613df09fa37)

Contributors should go through the [Contributing Guide](https://github.com/foss42/foss42-core/blob/main/CONTRIBUTING.md) to learn how to setup development environment, raise an issue and send across a PR.

# foss42

[![Discord Server Invite](https://img.shields.io/badge/DISCORD-JOIN%20SERVER-5663F7?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/2s49SCNfyJ)
![PyPI](https://img.shields.io/pypi/v/foss42?logo=python&logoColor=yellow&style=for-the-badge)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/foss42?logo=python&logoColor=yellow&style=for-the-badge)

Expand All @@ -12,16 +19,17 @@ Core Python library for [foss42 Open Source APIs](https://github.com/foss42/api)
pip3 install foss42
```

## Testing
## List of available functions

Install `pytest`
[Link](https://foss42.github.io/foss42-core)

```
$ pip3 install pytest
```
## Usage example

Clone the repo, set it as the current working directory and run the tests using the command:

```
$ pytest
```python
>>> import foss42.text.humanize as hz
>>> hz.humanize_bytes(1126,
2,
prefix = True,
trailing_zeros = True)
>>> '1.10 kilobytes'
```

0 comments on commit 5742a46

Please sign in to comment.