Skip to content

Commit 1a367a7

Browse files
committed
Initial package files and README
1 parent f13a42d commit 1a367a7

File tree

5 files changed

+94
-0
lines changed

5 files changed

+94
-0
lines changed

.gitignore

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
/dist
2+
/*.egg-info
3+
/build
4+
5+
# Mac files
6+
.DS_Store
7+
8+
# cache files
9+
__pycache__/

LICENSE.txt

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Copyright 2020 Casey Duckering
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
4+
5+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
6+
7+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
8+

README.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
<img alt="Demo animation" src="https://raw.githubusercontent.com/cduck/alime/master/docs/demo.gif?token=AAS4QHQEUYBAI4VLH6R75EC667FW2" height="98">
2+
3+
# Alime: Animated anti-bot email obfuscation for your website
4+
5+
- Stops email scraping bots that don't understand CSS transforms and page layout
6+
- Works without JavaScript (JavaScript is only used to make a clickable mailto: link)
7+
8+
[Demo page](https://cduck.github.io/alime/demo.html)
9+
10+
11+
## Usage
12+
13+
- Install the tool from PyPI:
14+
```bash
15+
python3 -m pip install alime
16+
```
17+
- Run alime with your email:
18+
```bash
19+
python3 -m alime '[email protected]'
20+
```
21+
alime-example.html, alime.css, and alime.js are created in the current directory.
22+
- Copy alime.css and alime.js (optional for mailto: hyperlink support) to your website.
23+
- Copy the marked contents of alime-example.html into your webpage HTML source.
24+
25+
More options are available by using alime from Python code:
26+
```python
27+
import alime
28+
help(alime.Alime)
29+
30+
gen = alime.Alime('[email protected]')
31+
gen.generated_html, gen.generated_css, gen.generated_js
32+
gen.save()
33+
```

docs/demo.gif

891 KB
Loading

setup.py

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
from setuptools import setup, find_packages
2+
import logging
3+
logger = logging.getLogger(__name__)
4+
5+
name = 'alime'
6+
package_name = name
7+
version = '0.1.0'
8+
9+
try:
10+
with open('README.md', 'r') as f:
11+
long_desc = f.read()
12+
except:
13+
logger.warning('Could not open README.md. '
14+
'long_description will be set to None.')
15+
long_desc = None
16+
17+
setup(
18+
name = package_name,
19+
packages = find_packages(),
20+
entry_points = {
21+
'console_scripts': [
22+
'alime=alime.__main__:main',
23+
]},
24+
version = version,
25+
description = 'Animated anti-bot email obfuscation for your website',
26+
long_description = long_desc,
27+
long_description_content_type = 'text/markdown',
28+
author = 'Casey Duckering',
29+
url = f'https://github.com/cduck/{name}',
30+
download_url = f'https://github.com/cduck/{name}/archive/{version}.tar.gz',
31+
keywords = ['html', 'css', 'email', 'scrape'],
32+
classifiers = [
33+
'License :: OSI Approved :: MIT License',
34+
'Development Status :: 3 - Alpha',
35+
'Programming Language :: Python :: 3',
36+
'Programming Language :: Python :: 3.7',
37+
'Programming Language :: Python :: 3.8',
38+
'Framework :: IPython',
39+
'Framework :: Jupyter',
40+
],
41+
install_requires = [
42+
],
43+
)
44+

0 commit comments

Comments
 (0)