AISExplorer


NameAISExplorer JSON
Version 0.2.1 PyPI version JSON
download
home_pagehttps://github.com/reyemb/AISExplorer
SummaryWrapper to fetch data from marinetraffic
upload_time2023-11-10 14:19:47
maintainer
docs_urlNone
authorreyemb
requires_python>=3.9
license
keywords ais vessel shiptracking shiplocation location proxy marinetraffic
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # AISExplorer  

![PyPI](https://img.shields.io/pypi/v/AISExplorer)
![PyPI - Downloads](https://img.shields.io/pypi/dm/AISExplorer)
![example workflow](https://github.com/reyemb/AISExplorer/actions/workflows/python-package.yml/badge.svg?style=for-the-badge)

AISExplorer is a tool for locating vessels or scraping vessel data in a specific area. However, due to recent updates, the use of free proxies, previously scraped from sources like [sslproxies](https://www.sslproxies.org/), has been discontinued due to errors such as 403 Forbidden responses.

## Next Steps

- Explore additional sources for proxy lists.
- Implement a method to customize the number of retries.
- Introduce functionality to reset filters.

## Changelog

### 2023-11-10

  - Due to Captcha implementation, login functionality is broken.
  - Sending requests through proxies now leads to a 403 error; proxy support has been removed.

### 2023-1-21

- Integrated login functions for additional features.

### 2021-12-10

- Implemented fallback if a proxy fails.
- Introduced the ability to retrieve data directly via URL.
- Added checks for Cloudflare's filtering mechanisms.

### 2021-12-5

- Early stages of filter implementation.
- Retry options were added for resilience.
- New exceptions were introduced for better error handling.

### 2021-11-27

- Proxy support was added (discontinued as of 2023-11-10).

## Installation

``` cmd
pip install aisexplorer
```

## Usage

### Find vessel by MMIS
Retrieve the current location of a vessel using its MMSI identifier.

```python
from aisexplorer.AIS import AIS

AIS().get_location(211281610)
```

### Find vessels in Area
Retrieve data for up to 500 vessels within a designated area.

**maximum 500 vessels**

```python
from aisexplorer.AIS import AIS

AIS(return_df= True).get_area_data("EMED")
```

The output is limited to 500 rows. Area codes can be referenced from the MarineTraffic help section.
[Areas](https://help.marinetraffic.com/hc/en-us/articles/214556408-Areas-of-the-World-How-does-MarineTraffic-segment-them-) can be found here

### Get Table via URL
Directly access table data using a MarineTraffic URL.

```python
from aisexplorer.AIS import AIS

AIS(return_df = True).get_data_by_url("https://www.marinetraffic.com/en/data/?asset_type=vessels&columns=time_of_latest_position:desc,flag,shipname,photo,recognized_next_port,reported_eta,reported_destination,current_port,imo,ship_type,show_on_live_map,area,lat_of_latest_position,lon_of_latest_position,speed,length,width&area_in|in|West%20Mediterranean,East%20Mediterranean|area_in=WMED,EMED&time_of_latest_position_between|gte|time_of_latest_position_between=60,NaN")
```

### Use Proxies

Previously, AISExplorer allowed fetching data using proxies for anonymization. This feature is no longer supported due to compatibility issues with the data source.

### Get Data for user created fleets

No longer available as it required user login, which is now deprecated due to captcha implementation.


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/reyemb/AISExplorer",
    "name": "AISExplorer",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "",
    "keywords": "AIS,Vessel,Shiptracking,Shiplocation,Location,Proxy,marinetraffic",
    "author": "reyemb",
    "author_email": "info@reyemb.io",
    "download_url": "https://files.pythonhosted.org/packages/10/ef/cb10a2ed9f332c8bbb2fd5647c9109635d9e6b43c92bf0513bbc10c6d0a4/aisexplorer-0.2.1.tar.gz",
    "platform": null,
    "description": "# AISExplorer  \n\n![PyPI](https://img.shields.io/pypi/v/AISExplorer)\n![PyPI - Downloads](https://img.shields.io/pypi/dm/AISExplorer)\n![example workflow](https://github.com/reyemb/AISExplorer/actions/workflows/python-package.yml/badge.svg?style=for-the-badge)\n\nAISExplorer is a tool for locating vessels or scraping vessel data in a specific area. However, due to recent updates, the use of free proxies, previously scraped from sources like [sslproxies](https://www.sslproxies.org/), has been discontinued due to errors such as 403 Forbidden responses.\n\n## Next Steps\n\n- Explore additional sources for proxy lists.\n- Implement a method to customize the number of retries.\n- Introduce functionality to reset filters.\n\n## Changelog\n\n### 2023-11-10\n\n  - Due to Captcha implementation, login functionality is broken.\n  - Sending requests through proxies now leads to a 403 error; proxy support has been removed.\n\n### 2023-1-21\n\n- Integrated login functions for additional features.\n\n### 2021-12-10\n\n- Implemented fallback if a proxy fails.\n- Introduced the ability to retrieve data directly via URL.\n- Added checks for Cloudflare's filtering mechanisms.\n\n### 2021-12-5\n\n- Early stages of filter implementation.\n- Retry options were added for resilience.\n- New exceptions were introduced for better error handling.\n\n### 2021-11-27\n\n- Proxy support was added (discontinued as of 2023-11-10).\n\n## Installation\n\n``` cmd\npip install aisexplorer\n```\n\n## Usage\n\n### Find vessel by MMIS\nRetrieve the current location of a vessel using its MMSI identifier.\n\n```python\nfrom aisexplorer.AIS import AIS\n\nAIS().get_location(211281610)\n```\n\n### Find vessels in Area\nRetrieve data for up to 500 vessels within a designated area.\n\n**maximum 500 vessels**\n\n```python\nfrom aisexplorer.AIS import AIS\n\nAIS(return_df= True).get_area_data(\"EMED\")\n```\n\nThe output is limited to 500 rows. Area codes can be referenced from the MarineTraffic help section.\n[Areas](https://help.marinetraffic.com/hc/en-us/articles/214556408-Areas-of-the-World-How-does-MarineTraffic-segment-them-) can be found here\n\n### Get Table via URL\nDirectly access table data using a MarineTraffic URL.\n\n```python\nfrom aisexplorer.AIS import AIS\n\nAIS(return_df = True).get_data_by_url(\"https://www.marinetraffic.com/en/data/?asset_type=vessels&columns=time_of_latest_position:desc,flag,shipname,photo,recognized_next_port,reported_eta,reported_destination,current_port,imo,ship_type,show_on_live_map,area,lat_of_latest_position,lon_of_latest_position,speed,length,width&area_in|in|West%20Mediterranean,East%20Mediterranean|area_in=WMED,EMED&time_of_latest_position_between|gte|time_of_latest_position_between=60,NaN\")\n```\n\n### Use Proxies\n\nPreviously, AISExplorer allowed fetching data using proxies for anonymization. This feature is no longer supported due to compatibility issues with the data source.\n\n### Get Data for user created fleets\n\nNo longer available as it required user login, which is now deprecated due to captcha implementation.\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Wrapper to fetch data from marinetraffic",
    "version": "0.2.1",
    "project_urls": {
        "Homepage": "https://github.com/reyemb/AISExplorer",
        "Repository": "https://github.com/reyemb/AISExplorer"
    },
    "split_keywords": [
        "ais",
        "vessel",
        "shiptracking",
        "shiplocation",
        "location",
        "proxy",
        "marinetraffic"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5a53d8ad4d1b5a7b098f0b5a3fc8665d49316cdb9d01b4d01c594efca315ffdf",
                "md5": "6b7336a2b23b8a8341929068a4cb8111",
                "sha256": "0f7f60c4770c776274ad4b875274a33adf591e4a7f87920f347dbdce337d42c0"
            },
            "downloads": -1,
            "filename": "aisexplorer-0.2.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6b7336a2b23b8a8341929068a4cb8111",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 14976,
            "upload_time": "2023-11-10T14:19:46",
            "upload_time_iso_8601": "2023-11-10T14:19:46.560633Z",
            "url": "https://files.pythonhosted.org/packages/5a/53/d8ad4d1b5a7b098f0b5a3fc8665d49316cdb9d01b4d01c594efca315ffdf/aisexplorer-0.2.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "10efcb10a2ed9f332c8bbb2fd5647c9109635d9e6b43c92bf0513bbc10c6d0a4",
                "md5": "a963ea468d2f14d1ddeeb4c53e3fd13c",
                "sha256": "af0c01a39b671a077e2c832e13224393f4c0b9338904adb051966f6cf50d92bb"
            },
            "downloads": -1,
            "filename": "aisexplorer-0.2.1.tar.gz",
            "has_sig": false,
            "md5_digest": "a963ea468d2f14d1ddeeb4c53e3fd13c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 14257,
            "upload_time": "2023-11-10T14:19:47",
            "upload_time_iso_8601": "2023-11-10T14:19:47.872542Z",
            "url": "https://files.pythonhosted.org/packages/10/ef/cb10a2ed9f332c8bbb2fd5647c9109635d9e6b43c92bf0513bbc10c6d0a4/aisexplorer-0.2.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-11-10 14:19:47",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "reyemb",
    "github_project": "AISExplorer",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "aisexplorer"
}
        
Elapsed time: 0.50348s