pyboxes 2.3.1
Pyboxes
License: MIT
Requires Python: >=3.9,<4.0

<div align="center">

# Pybox

<img src="https://raw.githubusercontent.com/cauliyang/pybox/main/docs/_static/logo.png" width=50% alt="logo">

[![pypi](https://img.shields.io/pypi/v/pyboxes.svg)][pypi status]
[![status](https://img.shields.io/pypi/status/pyboxes.svg)][pypi status]
[![python version](https://img.shields.io/pypi/pyversions/pyboxes)][pypi status]
[![license](https://img.shields.io/pypi/l/pyboxes)][license]
[![read the docs](https://img.shields.io/readthedocs/pyboxes/latest.svg?label=Read%20the%20Docs)][read the docs]

[![test](https://github.com/cauliyang/pybox/workflows/Tests/badge.svg)][test]
[![codecov](https://codecov.io/gh/cauliyang/pybox/branch/main/graph/badge.svg)][codecov]
[![precommit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)][precommit]
[![black](https://img.shields.io/badge/code%20style-black-000000.svg)][black]

[pypi status]: https://pypi.org/project/pyboxes/
[license]: https://opensource.org/licenses/MIT
[read the docs]: https://pyboxes.readthedocs.io/
[test]: https://github.com/cauliyang/pybox/actions?workflow=Tests
[codecov]: https://codecov.io/gh/cauliyang/pybox
[precommit]: https://github.com/pre-commit/pre-commit
[black]: https://github.com/psf/black
[//]: # '<img src="https://asciinema.org/a/vPzWEWZUJ4JUYkQPoj0Wgux42.svg" alt="demo" width=40%>'

</div>

## 💪 Aims

- **Simple**: A simple and easy to use Python library for many annoy task.
- **Easy to use**: Easy to use, you can use it in your project.
- **Extendable**: Extendable, you can add your own function easily.

## 🤩 Features

- [A simple and easy to download files by sharing link](#a-simple-and-easy-to-download-files-by-sharing-link)
- [A simple and easy to send message to Slack Channel](#a-simple-and-easy-to-send-message-to-slack-channel)
- [Download multiple files asynchronously](#download-multiple-files-asynchronously)
- Download Books from Zlib in terms of Title Will come!

## 🧐 Installation

You can install _Pybox_ via [pip] from [PyPI]:

```console
$ pip install pyboxes
```

## 📖 Usage

```console
$ pybox -h
```

Please see the Command-line Reference [Usage] for details.

## 🚌 Take a tour

### A simple and easy to download files by sharing link

1. Download single file by sharing link of Google Driver.

```console
$ pybox gfile <url> <name> <size>
```

2. Download files in a folder by client id and folder id.

```console
$ pybox gfolder <client_id> <folder_id>
```

Detailed usage please see [Usage Documentation]

### A simple and easy to send message to Slack Channel

```console
$ pybox slack [options] <webhook-url>
```

Detailed usage please see [Usage Documentation]

### Download multiple files asynchronously

1. Download single file.

```console
$ pybox asyncdown -u <url> -o <output>
```

2. Download multiple files.

```console
$ pybox asyncdown -f <url-file>
```

Detailed usage please see [Usage Documentation]

## 🤗 Contributing

Contributions are very welcome. To learn more, see the [Contributor Guide].

## 🤖 License

Distributed under the terms of the [MIT license],
_Pybox_ is free and open source software.

## 🤔 Issues

If you encounter any problems, please [file an issue] along with a detailed description.

## 🥳 Credits

This project was generated from [@cjolowicz]'s [Hypermodern Python Cookiecutter] template.

[@cjolowicz]: https://github.com/cjolowicz
[hypermodern python cookiecutter]: https://github.com/cjolowicz/cookiecutter-hypermodern-python
[mit license]: https://opensource.org/licenses/MIT
[pypi]: https://pypi.org/
[file an issue]: https://github.com/cauliyang/pybox/issues
[pip]: https://pip.pypa.io/
[google-driver]: https://www.google.com/drive/
[usage]: https://pyboxes.readthedocs.io/en/latest/usage.html
[slack]: https://slack.com/

<!-- github-only -->

![Alt](https://repobeats.axiom.co/api/embed/d2106d70cd519799cd18f0ca742bb9a4475fce88.svg "Repobeats analytics image")

[contributor guide]: CONTRIBUTING.md
[usage documentation]: https://pyboxes.readthedocs.io/en/latest/usage.html