Data

Tools

Indexes

Applications

Experiments

Open Source Science

tiktokapi

https://github.com/unibwsparta/tiktokapi

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.6%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: UnibwSparta
  • License: mit
  • Language: Python
  • Default Branch: main
  • Size: 2.72 MB
Statistics
  • Stars: 2
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 1
Created almost 2 years ago · Last pushed almost 2 years ago
Metadata Files
Readme License Citation

README.md

SPARTA TikTok API

Linting Status Test Status Build Status Python Version License Checked with mypy

Welcome to the official GitHub repository for the SPARTA TikTok API, a powerful Python implementation to interact with TikTok's Research API in a robust and efficient manner.

🚀 Features

  • Methods for gathering video metadata, users and more.
  • Asynchronous API calls support.
  • Efficient error handling.
  • Comprehensive documentation with usage examples.

📦 Installation

We recommend using Poetry for managing the project dependencies. If you don't have Poetry installed, check their official documentation for guidance.

To install the SPARTA TikTok API via Poetry:

bash poetry add sparta-tiktokapi

or to install it via pip:

bash pip3 install sparta-tiktokapi

📝 Quick Start

Here's a simple example to get you started:

```python from datetime import date from sparta.tiktokapi.access import createbearertoken from sparta.tiktokapi.videos.videos import query_videos

clientkey = "xxxxxxxxxxx" clientsecret = "xxxxxxxxxxx"

bearertoken = createbearertoken(clientkey, clientsecret) query = {"or": [{"operation": "IN", "fieldname": "username", "field_values": ["@tiktok"]}]} start = date(2023, 1, 1) end = date(2023, 1, 31)

async for video in queryvideos(bearertoken, query, start, end, max_count=100): print(video) ```

For in-depth methods and examples, consult our official documentation.

🛠 Development & Contribution

Clone the Repo:

bash git clone https://github.com/UnibwSparta/tiktokapi.git cd tiktokapi

Install Dependencies: bash poetry install

Submit Your Changes: Make your improvements and propose a Pull Request!

🧪 Testing

Tests are powered by pytest. Execute tests with:

bash poetry run pytest tests/

❓ Support & Feedback

Issues? Feedback? Use the GitHub issue tracker.

📜 License

MIT License. View LICENSE for details.

Project SPARTA

SPARTA is an interdisciplinary research project at the UniBw M. The Chair of Political Science is responsible for managing the project. The project is funded by dtec.bw (Digitalization and Technology Research Center of the Bundeswehr). dtec.bw is funded by the European Union - NextGenerationEU.

Owner

  • Login: UnibwSparta
  • Kind: user

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Neumeier"
  given-names: "Andreas"
- family-names: "Riedl"
  given-names: "Jasmin"
  orcid: "https://orcid.org/0000-0002-4888-7689"
title: "sparta-tiktokapi"
version: 0.1.0
date-released: 2024-07-22
url: "https://github.com/UnibwSparta/tiktokapi"

GitHub Events

Total
Last Year

Dependencies

.github/workflows/documentation.yaml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • peaceiris/actions-gh-pages v3 composite
  • snok/install-poetry v1 composite
.github/workflows/linting.yaml actions
  • actions/cache v3 composite
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • snok/install-poetry v1 composite
.github/workflows/publish.yaml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • pypa/gh-action-pypi-publish release/v1 composite
  • snok/install-poetry v1 composite
.github/workflows/test.yaml actions
  • actions/cache v3 composite
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • snok/install-poetry v1 composite
pyproject.toml pypi
  • black ^24.4.2 develop
  • coverage ^7.6.0 develop
  • docformatter ^1.7.5 develop
  • flake8 ^7.1.0 develop
  • isort ^5.13.2 develop
  • mypy ^1.11.0 develop
  • pytest ^8.3.1 develop
  • pytest-cov ^5.0.0 develop
  • types-requests ^2.32.0 develop
  • Sphinx ^7.4.7 docs
  • myst-parser ^3.0.1 docs
  • sphinx-rtd-theme ^2.0.0 docs
  • aiohttp ^3.9.5
  • asyncio ^3.4.3
  • pydantic ^2.8.2
  • python ^3.10.12
  • requests ^2.32.2