https://github.com/frc5024/raiderfetch
A library for getting information about the team. Similar to an API wrapper.
https://github.com/frc5024/raiderfetch
library python37
Last synced: 3 months ago
JSON representation
A library for getting information about the team. Similar to an API wrapper.
- Host: GitHub
- URL: https://github.com/frc5024/raiderfetch
- Owner: frc5024
- License: mit
- Created: 2018-10-08T20:54:14.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-10-09T13:48:18.000Z (over 6 years ago)
- Last Synced: 2025-01-31T19:39:07.891Z (4 months ago)
- Topics: library, python37
- Language: Python
- Homepage: https://pypi.org/project/RaiderFetch/
- Size: 4.88 KB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RaiderFetch
[](https://badge.fury.io/py/RaiderFetch) [](https://pypi.org/project/RaiderFetch/)
A python3 library for getting information about the team.
## Installation
To install this library, either use pip:
```sh
python3 -m pip install RaiderFetch
```
or, use setuptools:
```sh
python3 setup.py install
```
## Usage
This is the recommended usage for the library
### Import the library
First, import the library
```python3
import RaiderFetch as rf
```
### Create a fetcher
All of your work will be done through a fetcher class.
```python3
fetcher = rf.Fetcher()
```
A string of another account name can also be passed into the constructor. For example:
```python3
fetcher = rf.Fetcher("team254")
```
### Calling the api
For maximum control over the library, fetching data from the API is done manually. Nothing is returned by this function.
```python3
fetcher.fetch()
```
### Get the activity feed
To get info from GitHub about the team's activity, use this function.
```python3
fetcher.getFeed()
```
### Get a list of team members
To get a list of all current programming team members, use this function. Accounts marked as private will not be shown.
(NOTE: Team captains should have all members set their account to public)
```python3
fetcher.getMembers()
```
### Check if an account is a member of the team
To check if someone is a member of this team, pass their username into this function. A bool is returnewd by this function.
```python3
fetcher.isMember("username")
```
### Get a list of repos
To get a list of all public repos, along with some info about them, use:
```python3
fetcher.getRepos()
```