{ "info": { "author": "Fenimore Love", "author_email": "", "bugtrack_url": null, "classifiers": [], "description": "============\nIntroduction\n============\n\n\nFree Stuffs!\n------------\n\nThis is a Python 3.x package which scrapes free stuff from Craigslist.\nfreestuffs is under the MIT license. Check out the `source code `_\nand the `docs `_.\n\n* Using StuffScraper one can gather a list of free stuffs.\n* Using StuffCharter, one can create an HTML map of the free stuffs.\n\nThis package can be used to create a web application, such as the\nTreasure-map_ (source_), or for use on Twitter_.\n\n.. _Github: https://github.com/polypmer/freestuffs\n.. _Twitter: https://twitter.com/Freeebot\n.. _source: https://github.com/polypmer/treasure-map\n.. _Treasure-map: http://treasure.plyp.org\n\nInstallation\n------------\n\n``freestuffs`` can be installed with pip:\n\n.. code-block:: bash\n\n pip install freestuffs\n\nThe package has the following dependencies which are automatically\ninstalled by pip:\n\n* ``beautifulsoup4``\n* ``bs4``\n* ``folium``\n* ``geopy``\n* ``requests``\n* ``Unidecode``\n\nAdditionally, these may be manually installed using pip with\n``pip install -r requirements.txt``.\n\nGetting Started\n---------------\n\nStuffs\n******\n\nThe stuff class corresponds to a `Craiglist `_\nfree stuff posting. It's basic characteristics include title and location.\nNotably, there is no price attribute. If the posting has no image, the\n`Wikipedia `_ no-image image is used in it's place.\n\n::\n\n >>> from freestuffs.stuff_scraper import StuffScraper\n >>> stuffs = StuffScraper('montreal', 5).stuffs\n >>> print(stuffs[0])\n what: free shelves\n where: Workman St, montreal\n link: http://montreal.craigslist.ca/zip/5629811181.html\n image: https://images.craigslist.org/00r0r_4p06sM5Hn4O_300x300.jpg\n\nScape Stuffs\n************\n\nThe StuffScraper class will scrape Craiglist for\nfree stuff.\n\n::\n\n >>> from freestuffs.stuff_scraper import StuffScraper\n >>> stuffs = StuffScraper('montreal', 5).stuffs # precise=False\n >>> print(stuffs[0].thing) # Title\n Meubles / furniture\n\nIn order for the scraper to automatically\nscrape for latitude and longitude coordinates, pass in the\nparameter precise=True into the constructor.\n\n::\n\n >>> from freestuffs.stuff_scraper import StuffScraper\n >>> stuffs = StuffScraper('montreal', 5, precise=True).stuffs\n >>> print(stuffs[0].coordinates)\n ['45.617854', '-73.633931']\n\nChart Stuffs\n************\n\nThe StuffCharter class will produce a folium Map object populated\nwith free stuff from the StuffScraper.\n\n::\n\n >>> from freestuffs.stuff_scraper import StuffScraper\n >>> from freestuffs.stuff_charter import StuffCharter\n >>> stuffs = StuffScraper('montreal', 5, precise=True).stuffs\n >>> stuffs_chart = StuffCharter(stuffs)\n call save_map(path) generate html map\n >>> type(map.treasure_map)\n \n\nThe StuffCharter object is a wrapper around the folium.Map.\nCall :code:`save_map(HTML_PATH, CSS_PATH)`\n\n::\n\n >>> stuffs_chart.save_map('webmap', 'static/style.css')\n\nThis function creates a directory if it is not found in the path. Call instead\n:code:`save_test_map()` to generate an HTML map in the current directory.\n\n\nLegend\n+++++++++++++++++\n\n- The smaller the posting, the older it is.\n- The darker the border, the higher the amount of overlap.\n\nTriage\n++++++\n\nThe triage checks for regex search in this order:\n\n#. Red are furniture - wood, shelf, shelves, table, chair, scrap, desk.\n#. Blue are electronics: tv, sony, ecran, speakers, wire, electronic, saw, headphones, arduino.\n#. Black are the \"desired\" stuffs: book, games, cool, guide, box.\n#. White is default (no regex search matches).\n\nSupport\n-------\n\nThe easiest way to get support is to open an issue on `Github `_.\n", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/fenimore/freestuffs", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "freestuffs", "package_url": "https://pypi.org/project/freestuffs/", "platform": "", "project_url": "https://pypi.org/project/freestuffs/", "project_urls": { "Homepage": "https://github.com/fenimore/freestuffs" }, "release_url": "https://pypi.org/project/freestuffs/0.1.6/", "requires_dist": null, "requires_python": "", "summary": "Find free stuff near you!", "version": "0.1.6" }, "last_serial": 2811501, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "a0ed9727212383143674afdd462193d8", "sha256": "615f91d0ff683026e12bcb5323d76375d0134940a87e051018c4c8788165861e" }, "downloads": -1, "filename": "freestuffs-0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "a0ed9727212383143674afdd462193d8", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 19613, "upload_time": "2016-06-12T19:24:18", "url": "https://files.pythonhosted.org/packages/c8/80/b52ea3085cbbd6f1e705a3fb82f8c0e3af1c45331373071851f93e1e8c4c/freestuffs-0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "55987c3e1e71729053be3367bd9286c3", "sha256": "4e7733e533a12f7e0dea2544ccafff3163ab329047cca279da84e2d848541db4" }, "downloads": -1, "filename": "freestuffs-0.1.tar.gz", "has_sig": false, "md5_digest": "55987c3e1e71729053be3367bd9286c3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17510, "upload_time": "2016-06-12T19:24:13", "url": "https://files.pythonhosted.org/packages/1e/6b/6e16785140b968cd225f25d728fe2456a02a7f75151e961cfed48dee3de1/freestuffs-0.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "b403c062a0829c074654154c6061c940", "sha256": "846260517ea8f88047159af492f7babdb1da4a40a39bf3aba2803a0544a0446b" }, "downloads": -1, "filename": "freestuffs-0.1.2.tar.gz", "has_sig": false, "md5_digest": "b403c062a0829c074654154c6061c940", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17894, "upload_time": "2017-04-02T17:01:14", "url": "https://files.pythonhosted.org/packages/0f/f0/85dc874a62e72ffc99d0d560e51a9aef80e7b8d7efd9e34a76950f93027b/freestuffs-0.1.2.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "baedd84c0dfa2c0a39cd717be41b5da9", "sha256": "a8ef933a528f5f1ddb49917b609ba6006e19324c0f2b4e1dc062e92ab9033b2b" }, "downloads": -1, "filename": "freestuffs-0.1.3.tar.gz", "has_sig": false, "md5_digest": "baedd84c0dfa2c0a39cd717be41b5da9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17980, "upload_time": "2017-04-02T17:07:39", "url": "https://files.pythonhosted.org/packages/22/bd/0de9f60304fc72fe47018ac986505fa3cabf30e221ad105301b0ef1f67ba/freestuffs-0.1.3.tar.gz" } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "3945c8836b240b30ccbc6ed488373c41", "sha256": "7d2042a6c144ad4a6962dc38fe2f48e908430f693ab3f34cde5a17ece9019914" }, "downloads": -1, "filename": "freestuffs-0.1.4.tar.gz", "has_sig": false, "md5_digest": "3945c8836b240b30ccbc6ed488373c41", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17967, "upload_time": "2017-04-18T02:50:14", "url": "https://files.pythonhosted.org/packages/6c/35/a912fd494fb7af7f86f86b4cbe5794a84d979b7bc043a143a0da8a19e94d/freestuffs-0.1.4.tar.gz" } ], "0.1.5": [ { "comment_text": "", "digests": { "md5": "5a8fa4e8ff56b279159472a185ecf3e8", "sha256": "1083eeb07e2ac30665e283845a89e40e8cb1b519452b482343ecdee91a1b36a7" }, "downloads": -1, "filename": "freestuffs-0.1.5.tar.gz", "has_sig": false, "md5_digest": "5a8fa4e8ff56b279159472a185ecf3e8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17966, "upload_time": "2017-04-18T15:39:06", "url": "https://files.pythonhosted.org/packages/35/22/91f5a28f3985aead9dd680dc0016537f267d1061e5ff1d8a3a8ac3d92eb4/freestuffs-0.1.5.tar.gz" } ], "0.1.6": [ { "comment_text": "", "digests": { "md5": "a84c6cdc60f2955ee6abe0ff968a16ce", "sha256": "2bac86d08d38ad00469b6f97a25fe001df830b5b0f657e6d503058153f44f395" }, "downloads": -1, "filename": "freestuffs-0.1.6.tar.gz", "has_sig": false, "md5_digest": "a84c6cdc60f2955ee6abe0ff968a16ce", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17968, "upload_time": "2017-04-18T15:45:43", "url": "https://files.pythonhosted.org/packages/aa/1e/d49ac07310a3e9deb206fde136415db3627b9a13cefd7fca3c327168c261/freestuffs-0.1.6.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "a84c6cdc60f2955ee6abe0ff968a16ce", "sha256": "2bac86d08d38ad00469b6f97a25fe001df830b5b0f657e6d503058153f44f395" }, "downloads": -1, "filename": "freestuffs-0.1.6.tar.gz", "has_sig": false, "md5_digest": "a84c6cdc60f2955ee6abe0ff968a16ce", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17968, "upload_time": "2017-04-18T15:45:43", "url": "https://files.pythonhosted.org/packages/aa/1e/d49ac07310a3e9deb206fde136415db3627b9a13cefd7fca3c327168c261/freestuffs-0.1.6.tar.gz" } ] }