Skip to content

Commit b3362c6

Browse files
committed
Updating the README
2 parents 9130a9d + 3df5f97 commit b3362c6

File tree

1 file changed

+71
-53
lines changed

1 file changed

+71
-53
lines changed

README.md

Lines changed: 71 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,71 @@
1-
<img src="assets/img/logo.jpg">
2-
3-
# <>PyToMe
4-
5-
## Introduction
6-
We know how it's sometimes realy complicated for a developper in Cameroon to get hire by a companie for a full time job, or just get Hire for a single project, i created this project to resolve that problem (For Python developpers....), it's a really simple app, fetching and notify suscribers, PyToMe fetch jobs around multiple websites(Only PYTHON's one) and notify every developper that subscribe to it.
7-
8-
## How it's works
9-
PyToMe have a list of website where it wil fetch data(jobs/projects) and will notify developper with a frequency that will be configure.
10-
11-
## How to use it
12-
- First Suscribe to [PyToMe](https://github.com/pytome)
13-
- Enjoy ;-)
14-
15-
## How to install it locally
16-
* git clone https://github.com/Python-Cameroun/pytome
17-
* cd to/the/project/
18-
* launch **start_PytoMe.bat** (for windows user) and **start_PytoMe.sh** (for linux user)
19-
* The script will do the rest!
20-
21-
## Dependencies
22-
* requests
23-
* BeautifulSoup
24-
* schedule
25-
* Flask
26-
* For launch the local server on index.html, this code use http-server (allready install in node_modules/ directory)
27-
28-
## TODO
29-
- [OK] The Python Job with frequency
30-
- [ - ] Collecting/Fetching jobs all over website.
31-
- [ - ] The Mailing system to notify all developpers subscribed on this app.
32-
- [OK] The Web page where to suscribe to PyToMe.
33-
- [OK] Saving Mails.
34-
- [ - ] The Python Config (For personnalize notifications)
35-
- [ - ] The Type (Remote Jobs, full time, etc...).
36-
- [ - ] The country / city.
37-
- [ - ] The number of notifications.
38-
- [ - ] The delay from notifications.
39-
40-
## Rendering
41-
<img src="assets/img/rendu.png" />
42-
43-
## Author
44-
[Sanix-darker](https://github.com/sanix-darker)
45-
46-
## Contributors
47-
[Adonis Simo (root)](https://github.com/simo97)
48-
49-
## Organization
50-
[Python Cameroon](https://github.com/python-cameroun)
51-
52-
## License
53-
Be free to Use, fork this source code!
1+
<img src="assets/img/logo.jpg">
2+
3+
# <>PyToMe
4+
5+
## Introduction
6+
We know how it's sometimes realy complicated for a developper in Cameroon to get hire by a companie for a full time job, or just get Hire for a single project, i created this project to resolve that problem (For Python developpers....), it's a really simple app, fetching and notify suscribers, PyToMe fetch jobs around multiple websites(Only PYTHON's one) and notify every developper that subscribe to it.
7+
8+
## How it's works
9+
10+
PyToMe have a list of website where it will fetch data(jobs/projects) and will notify developers with a frequency that will be configure.
11+
12+
## How to use it in production:
13+
14+
- First Suscribe to [PyToMe](https://github.com/pytome)
15+
- Enjoy receiving offers;-)
16+
17+
## How to install it locally as a developper
18+
19+
You just need to hit theese commands:
20+
```shell
21+
git clone https://github.com/Python-Cameroun/pytome
22+
cd to/the/project/
23+
24+
# For Windows users, in the CLI hit this:
25+
start_PytoMe.bat
26+
27+
# For Windows users, in the CLI hit this:
28+
start_PytoMe.sh
29+
30+
#The script will do the rest for you!
31+
```
32+
33+
## Dependencies
34+
35+
Theese are few dependencies used in this project :
36+
37+
- requests
38+
- BeautifulSoup
39+
- schedule
40+
- Flask
41+
- For launch the local server on index.html, this code use http-server (allready install in node_modules/ directory)
42+
43+
## TODO
44+
45+
- [OK] The Python Job with frequency
46+
- [OK] Base engine for web scrappers
47+
- [OK] Default webscrapper available ( githubjob and python.org job's scrapper )
48+
- [ - ] Add Flask support
49+
- [ - ] The Mailing system to notify all developpers subscribed on this app.
50+
- [OK] The Web page where to suscribe to PyToMe.
51+
- [OK] Saving Mails.
52+
- [ - ] The Python Config (For personnalize notifications)
53+
- [ - ] The Type (Remote Jobs, full time, etc...).
54+
- [ - ] The country / city.
55+
- [ - ] The number of notifications.
56+
- [ - ] The delay from notifications.
57+
58+
## Rendering
59+
<img src="assets/img/rendu.png" />
60+
61+
## Author
62+
[Sanix-darker](https://github.com/sanix-darker)
63+
64+
## Contributors
65+
[Adonis Simo (root)](https://github.com/simo97)
66+
67+
## Organization
68+
[Python Cameroon](https://github.com/python-cameroun)
69+
70+
## License
71+
Be free to Update/Use, fork this source code!

0 commit comments

Comments
 (0)