File tree Expand file tree Collapse file tree 2 files changed +39
-1
lines changed
Expand file tree Collapse file tree 2 files changed +39
-1
lines changed Original file line number Diff line number Diff line change 66fetching /
77* .pyc
88* .egg *
9+ dist /
Original file line number Diff line number Diff line change 22
33This API allows users to upload their files permanently onto Arweave.
44
5- ## Installation :star :
5+ # Table of contents
6+
7+ - [ Arweave API] ( #arweave-api )
8+ - [ Install from package :package : ] ( #install-from-package-package )
9+ - [ Install for development :star : ] ( #install-for-development-star )
10+ - [ Usage :computer : ] ( #usage-computer )
11+ - [ Testing :gear : ] ( #testing-gear )
12+ - [ Endpoint documentation :scroll : ] ( #endpoint-documentation-scroll )
13+
14+ ## Install from package :package :
15+
16+ Once you have selected a package from the releases, take for example
17+ ` arweave_api-2023.9.7.1 ` :
18+
19+ Install with:
20+
21+ ``` sh
22+ # Setup a virtual environment
23+ python3 -m venv venv
24+ # Activate the virtual environment
25+ source venv/bin/activate
26+ # Install using python-pip
27+ python -m pip install -r arweave_api-2023.9.7.1-py3-none-any.whl
28+ ```
29+
30+ ### To show startup options:
31+
32+ ``` sh
33+ arweave-api -h
34+ ```
35+
36+ ### To run on the default port:
37+
38+ ``` sh
39+ arweave-api
40+ ```
41+
42+ ## Install for development :star :
643
744It is recommended to run a virtual environment locally. To do this, run the
845following:
You can’t perform that action at this time.
0 commit comments