Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
nmcassa committed Aug 25, 2022
1 parent 19ca2a4 commit 879fb82
Show file tree
Hide file tree
Showing 16 changed files with 64 additions and 18 deletions.
Binary file modified .DS_Store
Binary file not shown.
75 changes: 60 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,9 @@ print(nick.jsonify())
## **user_genre_info(user object)**

```python
from letterboxdpy import user
nick = user.User("nmcassa")
print(user_genre_info(nick))
print(user.user_genre_info(nick))
```

```
Expand All @@ -51,19 +52,41 @@ print(user_genre_info(nick))

## **user_following(user object) / user_followers(user object)**

returns the first page of the users following / followers
```python
from letterboxdpy import user
nick = user.User("nmcassa")
print(user.user_following(nick))
print(user.user_followers(nick))
```

```
['ryanshubert', 'Sean Baker', '24framesofnick', 'ConnorEatsPants', 'IHE', 'karsten', 'jordynhf']
['ryanshubert', 'Crescendo House', 'Brendonyu668', 'Parker Bobbitt', 'jordynhf', 'Dan']
```

## **user_films_watched(user object)**

returns all of the users watched movies
```python
from letterboxdpy import user
nick = user.User("nmcassa")
print(user.user_films_watched(nick))
```

```
...all of the users watched movies...
```

## **user_reviews(user object)**

returns a dictionary of information from reviews the user has made such as:
- movie's title
- movie's year
- user's rating on movie
- user's review
```python
from letterboxdpy import user
nick = user.User("nmcassa")
print(user.user_reviews(nick))
```

```
[{'movie': 'Beast', 'rating': ' ★½ ', 'date': '23 Aug 2022', 'review': 'Did not like it'}, {'movie': 'Men', 'rating': ' ★ ', 'date': '25 May 2022', 'review': 'What could he possibly be trying to say with this'}, {'movie': 'Nightcrawler', 'rating': ' ★★★ ', 'date': '04 May 2022', 'review': 'Jake is a pussy nerd loser in this'}, {'movie': 'The Graduate', 'rating': ' ★★★★ ', 'date': '30 Jan 2022', 'review': 'If only they didn’t play the same song like 20 times'}, {'movie': "I'm Thinking of Ending Things", 'rating': ' ★★★★ ', 'date': '14 Feb 2021', 'review': 'yeah i dont get it'}]
```

## **Movie Object**

Expand Down Expand Up @@ -107,23 +130,37 @@ print(king.jsonify())
## **movie_details(movie object)**

```python
from letterboxdpy import movie
king = movie.Movie("king kong", 2005)
print(movie_details(king))
print(movie.movie_details(king))
```
```
{'Country': ['New Zealand', 'USA', 'Germany'], 'Studio': ['Universal Pictures', 'WingNut Films', 'Big Primate Pictures', 'MFPV Film'], 'Language': ['English']}
```

## **movie_description(movie object)**

returns the description of the movie passed
```python
from letterboxdpy import movie
king = movie.Movie("king kong", 2005)
print(movie.movie_description(king))
```

```
In 1933 New York, an overly ambitious movie producer coerces his cast and hired ship crew to travel to mysterious Skull Island, where they encounter Kong, a giant ape who is immediately smitten with...
```

## **movie_popular_reviews(movie object)**

returns information about the movie's most popular reviews, such as:
- reviewer
- rating
- review
```python
from letterboxdpy import movie
king = movie.Movie("king kong" 2005)
print(movie.movie_popular_reviews(king))
```

```
[{'reviewer': 'BRAT', 'rating': ' ★★★½ ', 'review': 'naomi watts: bitch, it’s king kongking kong: yes, i’m king kongadrien brody: this is king kong?jack black: yes, miss king kong!!kyle chandler: and i’m kyle chandler :)'}, {'reviewer': 'josh lewis', 'rating': ' ★★★★ ', 'review': 'This review may contain spoilers. I can handle the truth.'}, {'reviewer': 'ashley 🥀', 'rating': ' ★½ ', 'review': 'To quote one of the funniest tweets I have ever seen: did King Kong really think he was gonna date that lady?'}, ...
```

## **List Object**

Expand Down Expand Up @@ -171,4 +208,12 @@ print(list.jsonify())

## **list_tags(list object)**

returns the tags under the list
```python
from letterboxdpy import list
a = list.List("Horrorville", "The Official Top 25 Horror Films of 2022")
print(list.list_tags(a))
```

```
['official', 'horror', 'letterboxd official', 'letterboxd', '2022', 'topprofile', 'top 25']
```
Binary file added dist/.DS_Store
Binary file not shown.
Binary file removed dist/letterboxdpy-1.8-py3-none-any.whl
Binary file not shown.
Binary file removed dist/letterboxdpy-1.8.tar.gz
Binary file not shown.
Binary file removed dist/letterboxdpy-2-py3-none-any.whl
Binary file not shown.
Binary file removed dist/letterboxdpy-2.1-py3-none-any.whl
Binary file not shown.
Binary file removed dist/letterboxdpy-2.1.tar.gz
Binary file not shown.
Binary file removed dist/letterboxdpy-2.2-py3-none-any.whl
Binary file not shown.
Binary file removed dist/letterboxdpy-2.2.tar.gz
Binary file not shown.
Binary file added dist/letterboxdpy-2.5-py3-none-any.whl
Binary file not shown.
Binary file added dist/letterboxdpy-2.5.tar.gz
Binary file not shown.
Binary file removed dist/letterboxdpy-2.tar.gz
Binary file not shown.
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "hatchling.build"

[project]
name = "letterboxdpy"
version = "2.2"
version = "2.5"
authors = [
{ name="Nicholas Cassarino", email="nmcassa804@outlook.com" },
]
Expand Down
3 changes: 2 additions & 1 deletion src/letterboxdpy/list.py
Original file line number Diff line number Diff line change
Expand Up @@ -76,4 +76,5 @@ def default(self, o):

if __name__ == "__main__":
list = List("Horrorville", "The Official Top 25 Horror Films of 2022")
print(list.jsonify())
#print(list.jsonify())
print(list_tags(list))
2 changes: 1 addition & 1 deletion src/letterboxdpy/user.py
Original file line number Diff line number Diff line change
Expand Up @@ -140,4 +140,4 @@ def default(self, o):
if __name__ == "__main__":
nick = User("nmcassa")
#print(nick.jsonify())
print(user_genre_info(nick))
print(user_reviews(nick))

0 comments on commit 879fb82

Please sign in to comment.