Skip to content

Commit 445f62a

Browse files
committed
Updated Pipfile and Readme
1 parent cd8207a commit 445f62a

File tree

2 files changed

+27
-22
lines changed

2 files changed

+27
-22
lines changed

Pipfile

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,14 @@ verify_ssl = true
44
name = "pypi"
55

66
[packages]
7-
requests = "*"
8-
os = "*"
97
sparkpost = "*"
10-
dotenv = "*"
8+
python-dotenv = "*"
119
pathlib = "*"
12-
PySimpleGUI = "*"
10+
pysimplegui = "*"
1311
requests = "*"
1412
feedparser = "*"
15-
ssl = "*"
13+
14+
[dev-packages]
15+
16+
[requires]
17+
python_version = "3.10"

README.md

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,25 @@
22

33
[Sign up](https://app.sparkpost.com/join?plan=free-0817?src=Social%20Media&sfdcid=70160000000pqBb&pc=GitHubSignUp&utm_source=github&utm_medium=social-media&utm_campaign=github&utm_content=sign-up) for a SparkPost account and visit our [Developer Hub](https://developers.sparkpost.com) for even more content.
44

5-
## Pre-requisites
5+
## Easy installation
6+
7+
Firstly ensure you have `python3`, `pip` and `git`.
68

7-
Firstly ensure you have `python` installed.
9+
Next, get the project. Install `pipenv` (`--user` option recommended, [see this article](https://stackoverflow.com/questions/42988977/what-is-the-purpose-pip-install-user)) and [this article for MacOS](https://stackoverflow.com/questions/60004431/pip-error-when-trying-to-run-pip-command-from-virtualenv-on-macos).
810

9-
Then install the following libraries with the following command:
10-
`pip install LIBRARYNAME`
11-
Or if on Mac/Linux:
12-
`pip3 install LIBRARYNAME`
11+
Once you have `pipenv`, you can use it to install the project dependencies.
12+
13+
```
14+
git clone https://github.com/ZSamuels28/SparkPost-RSS-Program.git
15+
cd SparkPost-RSS-Program
16+
python3 -m pip install pipenv
17+
pipenv install
18+
pipenv shell
19+
```
1320

14-
Necessary Libraries:
15-
`os`
16-
`sparkpost`
17-
`dotenv`
18-
`pathlib`
19-
`PySimpleGUI`
20-
`requests`
21-
`feedparser`
22-
`ssl`
21+
_Note: In the above commands, you may need to run `pip3` instead of `pip`._
2322

24-
Once installed, clone this repo.
23+
## Pre-requisites
2524

2625
Input your SparkPost API Key into the `sample.env` file and rename the file `variables.env`. Note these care case sensitive:
2726

@@ -47,7 +46,11 @@ NOTE: You must have templates and receipient lists created in SparkPost, if you
4746

4847
| NOTE: There currently is an issue with the PySimpleGui library and pop-ups randomly not appearing on M1 Macs. See [here](https://github.com/PySimpleGUI/PySimpleGUI/issues/5471) for current status. |
4948

50-
Locate and open the SparkPost-RSS.py file utilizing the command prompt or terminal with `python SparkPost-RSS.py` or `python3 SparkPost-RSS.py`.
49+
```
50+
cd SparkPost-RSS-Program
51+
pyenv shell
52+
python SparkPost-RSS.py
53+
```
5154

5255
You will see the SparkPost RSS Transmission program with the following inputs/options:
5356

0 commit comments

Comments
 (0)