Skip to content

Commit

Permalink
Update docs for 1.0 version
Browse files Browse the repository at this point in the history
  • Loading branch information
DEENUU1 committed Sep 17, 2023
1 parent f7e12ff commit 92c8e3d
Show file tree
Hide file tree
Showing 2 changed files with 74 additions and 1 deletion.
51 changes: 50 additions & 1 deletion docs/changelogs.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,59 @@
# Change log


## Current version: 0.9
## Current version: 1.0

## Version history

### 1.0
- Delete command to run web application without docker
- Post classification using transformers to check if post content is possitive or negative and save those data to database

```bash
python post-classifier <option>

Options:
--all-posts // Run post classification for all posts from the database
--id // Run post classification for specified post from the database
--person-id // Run post classification for a specified person from the database
```

- Add missing typehints
- Change the structure of a project
- Friend crawler (This command works similarly to the command that scrapes data about a given user's friends list. The difference, however, is that after scraping and creating Friend objects, it also creates objects for the CrawlerQueue model and after successfully scraping friends for one user, it proceeds to scraping the list of friends for the next user in the queue.)

#### Run crawler
Start crawler for specified facebook account
```bash
python main.py friend-crawler <facebook_id>
```

#### Display queue
Display all objects available in the queue
```bash
python main.py display-queue
```

#### Delete queue object
Delete specified queue object
```bash
python main.py delete-queue-object <id>
```

#### Clear queue
Delete all objects from the queue
```bash
python main.py clear-queue
```

- Option to scrape multiply users in full-scrape command

```bash
python main.py full-scrape <facebook_id> <facebook_id> <facebook_id>


```

### 0.9
- Add repository functions to return all data for specified Person object
- Implement LangChain and free Open Source LLM model to create summary for specified Person object based on scraped data
Expand Down
24 changes: 24 additions & 0 deletions docs/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -206,4 +206,28 @@ python main.py delete-queue-object <id>
Delete all objects from the queue
```bash
python main.py clear-queue
```


## Post classification using transformer

### Display Posts in CLI application
```bash
python main.py posts <option>

Options:
--display-all // Display all posts from the database
--id // Display a specified post from the database
--person-id // Display posts for a specified person from the database

```

### Run posts classfication
```bash
python post-classifier <option>

Options:
--all-posts // Run post classification for all posts from the database
--id // Run post classification for specified post from the database
--person-id // Run post classification for a specified person from the database
```

0 comments on commit 92c8e3d

Please sign in to comment.