From ee25087edb912e8710426fbc90c252577728878f Mon Sep 17 00:00:00 2001 From: Paul Date: Tue, 2 Jul 2024 14:41:42 -0400 Subject: [PATCH] move info about install from git/github to development section --- README.md | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index a55d1ba..179b454 100644 --- a/README.md +++ b/README.md @@ -6,24 +6,6 @@ video information from the TikTok Research API. ## Requirements Python3.11+ is **required**. Some newer features are directly used and earlier versions won't work (e.g. Walrus, type hinting chaining "|", etc., StrEnum) - -## Instalation and Usage - -Install with pip: - -```bash -git clone -cd tiktok-library -pip install . -``` -OR you can install `hatch` (see https://hatch.pypa.io/latest/install/) and run code/tests from that: -```bash -git clone -cd tiktok-library -hatch --env test run run # run unit tests -hatch run tiktok-lib run --db-url ... # query API -``` - # Basic CLI usage @@ -162,6 +144,24 @@ specify the connection string. # Development +## Installation + +Install with pip: + +```bash +git clone +cd tiktok-library +pip install . +``` +OR you can install `hatch` (see https://hatch.pypa.io/latest/install/) and run code/tests from that: +```bash +git clone +cd tiktok-library +hatch --env test run run # run unit tests +hatch run tiktok-lib run --db-url ... # query API +``` + + ## Testing To run unit tests locally (requires pytest installed): `python3 -m pytest` OR use hatch `hatch run test:run`