https://github.com/tushortz/youversion-bible-client

Unofficial Youversion bible api
https://github.com/tushortz/youversion-bible-client

Last synced: 5 days ago
JSON representation

Unofficial Youversion bible api

• Host: GitHub
• URL: https://github.com/tushortz/youversion-bible-client
• Owner: tushortz
• License: mit
• Created: 2018-10-26T10:52:04.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-07-10T08:08:43.000Z (4 months ago)
• Last Synced: 2024-07-10T10:02:08.212Z (4 months ago)
• Language: Python
• Size: 43 KB
• Stars: 8
• Watchers: 3
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Youversion Bible API

Unofficial Youversion bible api

## How to install

Run the following command in the terminal

>Note: Not implemented yet

```sh

$ pip install youversion-bible-client

```

## How to use

Import the client object

```py

from youversion.utils import Client

```

Create a new client object and instantiate it with a login credential.

```py

client = Client("", "")

```

call available methods on it

- moments()

- highlights()

- daily_verses()

- plan_progress()

- bookmarks()

- my_images()

- notes()

- plan_subscriptions()

- convert_note_to_md()

### Verse of the day

Getting the verse of the day

```py

# Get verse of the day for the current day

votd = client.verse_of_the_day()

print(votd)

>>> Votd(day=27, usfm=['PHP.4.19'], image_id=None)

# Prints the verse of the day object as a dictionary

print(votd.dict)

>>> {'day': 27, 'usfm': ['PHP.4.19'], 'image_id': None}

print(votd.day)

>>> 27

```

You can also get the verse of the day for a specific day

```py

votd = client.verse_of_the_day(355)

print(votd)

>>> Votd(day=355, usfm=['PSA.100.2'], image_id=None)

```

## Contributing

Interested in contributing, please create a fork of the project, modify your changes and create a pull request.

# TODO

* [x] login

* [ ] send friend request

* [ ] view friend requests

* [x] view moments

* [x] view notes

* [ ] create notes

* [ ] modify notes

* [ ] delete note

* [ ] write documentation

* [ ] write test

> Many more todo