You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+21-4Lines changed: 21 additions & 4 deletions
Display the source diff
Display the rich diff
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
33
33
* pipenv
34
34
* Scheduler tool to automatically run script periodically (optional)
35
35
36
+
## PyPi Project
37
+
https://pypi.org/project/fb2cal/
38
+
36
39
## Instructions
40
+
41
+
### PyPi (Recommended)
42
+
1. In an empty folder of your choice, set up pipenv environment
43
+
`pipenv install`
44
+
2. Install `fb2cal` module:
45
+
`pipenv run pip install fb2cal`
46
+
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`.
47
+
4. Update the `config/config.ini` file and enter your Facebook email and password (no quotes).
48
+
5. Run the `fb2cal` module
49
+
`pipenv run python -m fb2cal`
50
+
6. Check the output folder (`out` by default) for the created `birthdays.ics` file
51
+
52
+
### Local
37
53
1. Clone repo
38
54
`git clone git@github.com:mobeigi/fb2cal.git`
39
-
2. Rename `config/config-template.ini` to `config/config.ini` and enter your Facebook email and password (no quotes).
40
-
3. Set up pipenv environment
55
+
2. Copy `config/config-template.ini` to `config/config.ini`.
56
+
3. Update the `config/config.ini` file and enter your Facebook email and password (no quotes).
57
+
4. Set up pipenv environment
41
58
`pipenv install`
42
-
4. Run the `fb2cal` module
59
+
5. Run the `fb2cal` module
43
60
`pipenv run python -m fb2cal`
44
-
5. Check the output folder (`out` by default) for the created `birthdays.ics` file
61
+
6. Check the output folder (`out` by default) for the created `birthdays.ics` file
45
62
46
63
## Configuration
47
64
This tool can be configured by editing the `config/config.ini` configuration file.
0 commit comments