-
Notifications
You must be signed in to change notification settings - Fork 73
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #117 from mobeigi/update-documentation-for-1-3-0
Update readme for 1.3.0
- Loading branch information
Showing
1 changed file
with
21 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -33,15 +33,32 @@ After gathering a list of birthdays for all the users friends for a full year, i | |
* pipenv | ||
* Scheduler tool to automatically run script periodically (optional) | ||
|
||
## PyPi Project | ||
https://pypi.org/project/fb2cal/ | ||
|
||
## Instructions | ||
|
||
### PyPi (Recommended) | ||
1. In an empty folder of your choice, set up pipenv environment | ||
`pipenv install` | ||
2. Install `fb2cal` module: | ||
`pipenv run pip install fb2cal` | ||
3. Download [config/config-template.ini](https://raw.githubusercontent.com/mobeigi/fb2cal/master/config/config-template.ini) file and store it in `config/config.ini`. | ||
4. Update the `config/config.ini` file and enter your Facebook email and password (no quotes). | ||
5. Run the `fb2cal` module | ||
`pipenv run python -m fb2cal` | ||
6. Check the output folder (`out` by default) for the created `birthdays.ics` file | ||
|
||
### Local | ||
1. Clone repo | ||
`git clone [email protected]:mobeigi/fb2cal.git` | ||
2. Rename `config/config-template.ini` to `config/config.ini` and enter your Facebook email and password (no quotes). | ||
3. Set up pipenv environment | ||
2. Copy `config/config-template.ini` to `config/config.ini`. | ||
3. Update the `config/config.ini` file and enter your Facebook email and password (no quotes). | ||
4. Set up pipenv environment | ||
`pipenv install` | ||
4. Run the `fb2cal` module | ||
5. Run the `fb2cal` module | ||
`pipenv run python -m fb2cal` | ||
5. Check the output folder (`out` by default) for the created `birthdays.ics` file | ||
6. Check the output folder (`out` by default) for the created `birthdays.ics` file | ||
|
||
## Configuration | ||
This tool can be configured by editing the `config/config.ini` configuration file. | ||
|