Add PyPi files

Added necessary files for publishing the package.

Author: 2knal

Contributing.md

@@ -0,0 +1,13 @@
+## Contributing guidelines
+
+Thank you for your interest in contributing to random_proxies! Here are a few pointers about how you can help.
+
+### Setting things up
+
+To set up the development environment, follow the instructions in README.
+
+### Finding something to work on
+
+The issue tracker of random_proxies is a good place to start. If you find something that interests you, comment on the thread and we’ll help get you started. 
+
+Alternatively, if you come across a new bug on the site, please file a new issue and comment if you would like to be assigned. The existing issues are tagged with one or more labels, its importance etc, that can help you in selecting one.

LICENSE LICENSE.txt

@@ -9,7 +9,7 @@
 
 # random_proxies
 
-### Python package to generate a random proxy on the fly!
+Python package to generate a random proxy on the fly!
 
 ## Features
 
@@ -23,13 +23,16 @@
 
 
 ## Example usage
-
+<!-- ```bash
+  pip install random_proxies
+```
+or  -->
 ```bash
-  git clone https://github.com/2knal/random_proxies.git`
-  cd random_proxies/ 
-  pip install -r requirements.txt 
+  $ git clone https://github.com/2knal/random_proxies.git`
+  $ cd random_proxies/ 
+  $ pip install -r requirements.txt 
 ```
-Open python interpreter. (Supports version 3.4+)
+Open python interpreter. (Supports version 3.7+)
 
 ```python
 >>> from random_proxies import random_proxy
@@ -41,6 +44,24 @@ Refer more examples [here](./examples/)
 
 ## TODO
 - [ ] Publish package version 0.0.1 
+- [ ] Port to MongoDB
 - [ ] Scrape proxies from other sources
 - [ ] Add support for SOCKS version 5
+- [ ] Implement REST API to allow other languages to interface with it
+- [ ] Setup documentation page
 - [ ] Add unit tests
+
+------------------------------------------
+
+### Contributing
+
+ * We are open to `enhancements` & `bug-fixes` 😊. Take a look [here](./Contributing.md) to get started
+ * Feel free to add issues and submit patches
+
+
+### Author
+Kunal Sonawane - [2knal](https://github.com/2knal)
+
+------------------------------------------
+### License
+This project is licensed under the MIT - see the [LICENSE](./LICENSE.txt) file for details.

README.md

@@ -2,3 +2,4 @@
 from __future__ import absolute_import, unicode_literals
 
 from random_proxies.proxies import random_proxy
+from random_proxies.proxies.settings import __version__

random_proxies/__init__.py

@@ -0,0 +1 @@
+ELASTIC_PASSWORD=<PASSWORD>

random_proxies/cache_server/.env.sample

@@ -0,0 +1,8 @@
+# Inside of setup.cfg
+[metadata]
+description-file = README.md
+
+[flake8]
+exclude = .git, __pycache__, build, dist, docs, venv, .venv
+ignore = E711, E712, F821, E501, E722, E305, W605, W504, W504, E305
+max-line-length = 130

setup.cfg

@@ -0,0 +1,37 @@
+import pathlib
+from setuptools import setup, find_packages
+from random_proxies.proxies.settings import __version__
+
+# The directory containing this file
+HERE = pathlib.Path(__file__).parent
+
+# The text of the README file
+README = (HERE / "README.md").read_text()
+
+# This call to setup() does all the work
+setup(
+    name = "random_proxies",
+    version = __version__,
+    description = "Get a proxy server IP on the fly!",
+    long_description = README,
+    long_description_content_type = "text/markdown",
+    url = "https://github.com/2knal/random_proxies",
+    author = "Kunal Sonawane",
+    author_email = "[email protected]",
+    license = "MIT",
+    classifiers = [
+        "License :: OSI Approved :: MIT License",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.7",
+    ],
+    packages = find_packages(),
+    include_package_data = True,
+    install_requires = [
+        "beautifulsoup4==4.9.0",
+        "elasticsearch==7.6.0",
+        "lxml==4.5.0",
+        "PySocks==1.7.1",
+        "python-dotenv==0.13.0",
+        "requests==2.23.0"
+    ]
+)