Skip to content

Commit

Permalink
Edit: README Update
Browse files Browse the repository at this point in the history
  • Loading branch information
faridrasidov committed Oct 11, 2024
1 parent 313cc6e commit dfeb2b8
Showing 1 changed file with 35 additions and 13 deletions.
48 changes: 35 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
<div align="center">
<h1>SoundCld</h1>
<p>
Python Api Handler For The Internal V2 SoundCloud API. Does Not Require An API Key.
Python API handler for the SoundCloud Internal V2 API,
allowing interaction without an API key.
</p>

<!-- Badges -->
Expand All @@ -13,21 +14,31 @@
<a href="https://github.com/faridrasidov/soundcld"><img src="https://img.shields.io/github/forks/faridrasidov/soundcld?style=social" alt="forks - soundcld"></a>
</div>

****
**Installation:**
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Specifications](#specifications)
- [Authentication](#authentication)
- [License](#license)


<a name="installation"></a>
## Installation:
**Global Installation**
```shell
# For Global
$ git clone https://github.com/faridrasidov/soundcld
$ cd soundcld
$ pip install .
```
**Virtual Environment**
```shell
# For Venv
$ git clone https://github.com/faridrasidov/soundcld
$ cd soundcld
$ path/to/your/venv/pip install .
```
**Example Of Usage:**

<a name="usage"></a>
## Usage
```python
from soundcld import SoundCloud

Expand All @@ -38,17 +49,24 @@ for item in search:
print(item.permalink, item.kind)
```

**Specifications:**
<a name="specifications"></a>
## Specifications

- **You Can Change Your Profile Info**
- **45 Get Api Requests Has Been Handled.(Some Of Them Require Auth)**
- **7 Put Api Requests hs Been Handled. (All Of Them Require Auth)**
- **1 Post Api Requests hs Been Handled. (All Of Them Require Auth)**
- **2 Delete Api Requests hs Been Handled. (All Of Them Require Auth)**
- **Last Valid Generated ID's Automatically Added To 'data.json' File To improve Api Speed.**
- **46 Get Api Requests Has Been Handled.(Some Of Them Require Auth)**
- **You Can Change Your Profile Info Too**
****


<a name="authentication"></a>
## Authentication
**Notes about `auth`:**

**Some methods require authentication. If you want to use them, you should get the values
written at the bottom from your cookies and put them in a package folder ("soundcloud")
named cookies.json. You will also need to change your "client_id" in data.json in that folder.**
written at the bottom from your cookies and put them in file which is in package folder ("soundcloud")
named cookies.json. You will also need to change your "client_id" in data.json file in that folder.**

**Save Them Into:**

Expand All @@ -71,4 +89,8 @@ named cookies.json. You will also need to change your "client_id" in data.json i
"client_id": "<client_id>",
"app_version": "<app_version>"
}
```
```

<a name="license"></a>
## License
`Soundcld` source code is licensed under the terms of the Boost Software License. See [LICENSE](https://github.com/faridrasidov/soundcld/blob/master/LICENCE.txt) for more information.

0 comments on commit dfeb2b8

Please sign in to comment.