Forks/freemail
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Make it an actual pip installable package

Browse Source
This commit is contained in:
Allard Stijnman
2016-03-23 17:33:58 +01:00
parent 748b86b901
commit 82017dd051
25 changed files with 742 additions and 126 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+5 -26
View File
@@ -1,4 +1,4 @@
[![Build Status](https://travis-ci.org/willwhite/freemail.svg?branch=master)](https://travis-ci.org/willwhite/freemail)
[![Build Status](https://travis-ci.org/wearespindle/freemail.svg?branch=master)](https://travis-ci.org/wearespindle/freemail)
# freemail
@@ -16,9 +16,9 @@ domains directly by opening a pull request.
There are three key data files in this project:
- [free.txt](https://github.com/willwhite/freemail/blob/master/data/free.txt) contains a list of domains that are known to provide free email service
- [disposable.txt](https://github.com/willwhite/freemail/blob/master/data/disposable.txt) contains a list of domains that are known to provide disposable email service
- [blacklist.txt](https://github.com/willwhite/freemail/blob/master/data/blacklist.txt) contains a list of domains that this project will refuse to add to either list
- [free.txt](https://github.com/wearespindle/freemail/blob/master/data/free.txt) contains a list of domains that are known to provide free email service
- [disposable.txt](https://github.com/wearespindle/freemail/blob/master/data/disposable.txt) contains a list of domains that are known to provide disposable email service
- [blacklist.txt](https://github.com/wearespindle/freemail/blob/master/data/blacklist.txt) contains a list of domains that this project will refuse to add to either list
Domains may only be a member of one list.
@@ -29,27 +29,6 @@ Run `./update` to pull in the latest domains from the sources listed in
If any domains provide disposable email service, they may be moved to
`disposable.txt`.
## Node
### Install
```
npm install --save freemail
```
```javascript
var freemail = require('freemail');
freemail.isFree('smith@gmail.com');
> true
freemail.isFree('jack@mailinater.com');
> true
freemail.isDisposable('smith@gmail.com');
> false
freemail.isDisposable('jack@mailinater.com');
> true
```
## Python
### Install
@@ -60,7 +39,7 @@ pip install freemail
```python
>>> import freemail
>>> freemail.is_free('jack@mailinater.com')
>>> freemail.is_free('smith@gmail.com')
True
>>> freemail.is_free('jack@mailinater.com')
True