Skip to content

Commit

Permalink
chore: update README to be like the others
Browse files Browse the repository at this point in the history
  • Loading branch information
@Aviortheking
Aviortheking committed Sep 25, 2024
1 parent 6ce7b11 commit 72f1ce3
Showing 1 changed file with 44 additions and 90 deletions.
134 changes: 44 additions & 90 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,139 +7,93 @@
<a href="http://pypi.org/project/tcgdex-sdk">
<img src="https://img.shields.io/pypi/v/tcgdex-sdk?style=flat-square" alt="Pypi Version">
</a>
<a href="http://npmjs.com/@tcgdex/sdk">
<a href="http://pypi.org/project/tcgdex-sdk">
<img src="https://img.shields.io/pypi/dm/tcgdex-sdk?style=flat-square" alt="Pypi Downloads">
</a>
<a href="https://github.com/tcgdex/python-sdk/stargazers">
<img src="https://img.shields.io/github/stars/tcgdex/python-sdk?style=flat-square" alt="Github stars">
</a>
<a href="https://github.com/tcgdex/python-sdk/actions/workflows/build.yml">
<img src="https://img.shields.io/github/workflow/status/tcgdex/javascript-sdk/Build%20&%20Test?style=flat-square" alt="the TCGdex JAvascript SDK is released under the MIT license." />
<img src="https://img.shields.io/github/actions/workflow/status/tcgdex/python-sdk/build.yml?style=flat-square" alt="the TCGdex Python SDK is released under the MIT license." />
</a>
<a href="https://discord.gg/NehYTAhsZE">
<a href="https://discord.gg/peACSRMZ7V">
<img src="https://img.shields.io/discord/857231041261076491?color=%235865F2&label=Discord&style=flat-square" alt="Discord Link">
</a>
</p>

# TCGdex Python SDK

The Javascript/Typescript SDK provides a convenient access with the Open Source TCGdex API.

The SDK is available in ESM and CommonJS and should be automaticly chosen.

## Documentation
The TCGdex Python SDK provides a convenient access with the Open Source TCGdex API.

_The full API/SDK documentation in progress at [API Documentation - TCGdex](https://www.tcgdex.dev)_
_The full API/SDK documentation is available at [API Documentation - TCGdex](https://www.tcgdex.dev)_

### Getting Started

#### How To install

**In the browser**

To use the SDK in the browser, simply add the following script tag to your
HTML pages:

```html
<script src="https://cdn.jsdelivr.net/npm/@tcgdex/sdk@2/dist/tcgdex.browser.js"></script>
```

You cna also download the script from [JSDelivr](https://cdn.jsdelivr.net/npm/@tcgdex/sdk@2/dist/tcgdex.browser.js) by right clicking the link and selecting save link as.

**In Node.js**

Simply type the following into a terminal window:
run the following command:

```bash
npm install @tcgdex/sdk
pip install tcgdex-sdk
```

#### Usage

_Note: a complete documentation is available at [TCGdex.dev](https://www.tcgdex.dev)_
#### Getting Started

**Example: Fetch a Card**

_in Browser_

```html
<script src="https://cdn.jsdelivr.net/npm/@tcgdex/sdk@2.4.9/dist/tcgdex.browser.js"></script>
<script>
// Instantiate the SDK
const tcgdex = new TCGdex('en');
// go into an async context
;(async () => {
// Card will be Furret from the Darkness Ablaze Set
const card = await tcgdex.fetch('cards', 'swsh3-136');
})();
</script>
```

_in NodeJS (in an async context)_

```typescript
// Import the SDK in Typescript or moduleJS
import TCGdex from '@tcgdex/sdk'

// import the SDK in commonJS
const TCGdex = require('@tcgdex/sdk').default

// Instantiate the SDK
const tcgdex = new TCGdex('en');

// go into an async context
(async () => {
// Card will be Furret from the Darkness Ablaze Set
const card = await tcgdex.fetch('cards', 'swsh3-136');

// You can also get the same result using
const card = await tcgdex.fetch('sets', 'Darkness Ablaze', 136);
})();
```python
from tcgdexsdk import TCGdex

tcgdex = TCGdex("en") # You can also use `Language.EN` TCGdex(Language.EN)
res = await tcgdex.card.get("swsh1-136")
```

**Other Examples**

```javascript
// fetch a Set's informations using the set's name or ID
await tcgdex.fetch('sets', 'Darkness Ablaze')
```python
# fetch a Set using the set's name or ID
await tcgdex.set.get('Darkness Ablaze')

// Fetch a serie using the serie's name or ID
await tcgdex.fetch('series', 'Sword & Shield')
# Fetch a serie using the serie's name or ID
await tcgdex.serie.get('Sword & Shield')

// Fetch cards possible pokemon cards HP
await tcgdex.fetch('hp');
# Fetch cards possible pokemon cards HP
await tcgdex.hp.list()

// Fetch Cards with the specific number of HP
await tcgdex.fetch('hp', 110);
# Fetch Cards with the specific number of HP
await tcgdex.hp.get('110')

// Fetch cards possible illustrators
await tcgdex.fetch('illustrators');
# Fetch cards possible illustrators
await tcgdex.illustrator.list()

// Fetch Cards with the specific illustrator
await tcgdex.fetch('illustrators', 'tetsuya koizumi');
# Fetch Cards with the specific illustrator
await tcgdex.illustrator.get('tetsuya koizumi')
```

**Other Endpoints**

_They work like the two (`hp` and `illustrators`) abose_
Every endpoints below work just like the ones above
- a function `list` to get the list of elements
- a function `get` to get details on the element

- `variant`: fetch by the variants
- `trainerType`: fetch trainer cards types
- `suffix`: fetch differents cards suffixes
- `stage`: fetch differents cards stages
- `regulationMark`: Fetch by the regulation mark (letter at the bottom of the card)
- `energyType`: Fetch different types of energies
- `dexId`: fetch pokemon Global Pokédex IDS
- `type`: fetch the cards using the Pokémon type(s)
- `retreat`: fetch the cards using the retreat count
- `rarity`: fetch the cards rarities
- `illustrator`: fetch all the cards illustrators
- `hp`: fetch the different cards possible HPs
- `category`: the different cards categories

- categories: the the different cards categories
- energy-types: Fetch different types of energies
- hp: fetch the different cards possible HPs
- illustrators: fetch all the cards illustrators
- rarities: fetch the cards rarities
- retreats: fetch the cards using the retreat count
- stages: fetch differents cards stages
- suffixes: fetch differents cards suffixes
- trainer-types: fetch trainer cards types
- dex-ids: fetch pokemon Global Pokédex IDS
- types: fetch the cards using the Pokémon type(s)

## Contributing

See [CONTRIBUTING.md](https://github.com/tcgdex/javascript-sdk/blob/master/CONTRIBUTING.md)
See [CONTRIBUTING.md](https://github.com/tcgdex/python-sdk/blob/master/CONTRIBUTING.md)

TL::DR

Expand All @@ -151,4 +105,4 @@ TL::DR

## License

This project is licensed under the IT License. A copy of the license is available at [LICENSE.md](https://github.com/tcgdex/javascript-sdk/blob/master/LICENSE.md)
This project is licensed under the MIT License. A copy of the license is available at [LICENSE.md](https://github.com/tcgdex/python-sdk/blob/master/LICENSE.md)

0 comments on commit 72f1ce3

Please sign in to comment.