osmsg


Nameosmsg JSON
Version 0.3.0 PyPI version JSON
download
home_pageNone
SummaryOpenStreetMap Stats Generator: Commandline
upload_time2024-08-26 13:32:14
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseGPL-3.0-only
keywords osm stats commandline openstreetmap
VCS
bugtrack_url
requirements requests osmium pandas tweepy Shapely geopandas tqdm seaborn matplotlib humanize
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # OpenStreetMap Stats Generator

On the Fly Commandline Stats Generator for OpenStreetMap User Contributions

I tweet stats Every day/week/month for Global/Region and #hotosm hashtag at https://twitter.com/stats_osm and store them [OSMSG Stats Dir](https://github.com/kshitij-raj-sharma/OSMSG-stats/)

Monitored stats are available under `stats`, Currently Bot monitors OSM as whole , hotosm hashtag , Nepal Country : weekly,monthly and yearly stats are stored in github and twitter. 

### Usage:
For installation & Local Setup follow [Installation](./docs/Installation.md)
```
osmsg [-h] [--start_date START_DATE] [--end_date END_DATE] [--username USERNAME]
             [--password PASSWORD] [--timezone {Nepal,UTC}] [--name NAME]
             [--country COUNTRY [COUNTRY ...]] [--tags TAGS [TAGS ...]]
             [--hashtags HASHTAGS [HASHTAGS ...]] [--length LENGTH [LENGTH ...]] [--force]
             [--field_mappers] [--meta] [--tm_stats] [--rows ROWS] [--users USERS [USERS ...]]
             [--workers WORKERS] [--url URL [URL ...]] [--last_week] [--last_day] [--last_month]
             [--last_year] [--last_hour] [--days DAYS] [--charts] [--summary] [--exact_lookup]
             [--changeset] [--all_tags] [--temp]
             [--format {csv,json,excel,image,text} [{csv,json,excel,image,text} ...]]
             [--read_from_metadata READ_FROM_METADATA] [--boundary BOUNDARY] [--update]
```

### Options:
Hit following command for listing out the option with their documentation
```
osmsg --help
```

### Features
It is a python package that processes osm files live and produces stats on the fly

1. It can Generate Stats on Country Level for countries based on geofabrik urls . Countries are available in [here](./data/countries.csv)
2. It can also take any other server replication changefile to extract stats (Tested with Geofabrik and Planet Replication)
3. Can Generate hashtag statistics
4. Supports multiple output formats , Visualize Automatic Stats Being Genarated [here](./stats/)
5. It can create summary charts automatically along with stats , Visualize them [here](./stats/Global/Daily/)
6. Can generate stats for any custom timestamp provided

```
{"name":"username","uid":uid,"changesets":1,"nodes.create":1071,"nodes.modify":2100,"nodes.delete":0,"ways.create":146,"ways.modify":69,"ways.delete":0,"relations.create":0,"relations.modify":1,"relations.delete":0,"building.create":138,"building.modify":11,"building.delete":0,"highway.create":5,"highway.modify":49,"highway.delete":0,"waterway.create":0,"waterway.modify":4,"waterway.delete":0,"amenity.create":0,"amenity.modify":3,"amenity.delete":0,"landuse.create":3,"landuse.modify":1,"landuse.delete":0,"natural.create":0,"natural.modify":3,"natural.delete":0,"total_map_changes":3387}
```

### Get Started :

- Extract Stat of last hour and visualize stats/charts
  
  By default replication is minute url.

```
osmsg --last_hour
```

- With Hashtags information

```
osmsg --last_hour --changeset
```

  
- Last week data with summary & all tags info and using day replication
```
osmsg --last_week --url day --summary --all_tags
```

For More , Follow [Manual](./docs/Manual.md)

### Contributing
Contributions are always welcome! Follow [Contributing Guidelines](./CONTRIBUTING.md) & Go through [Code of Conduct](./CODE_OF_CONDUCT.md)

### Version Control
Follow [Version Control Docs](./docs/Version_control.md)

### Request Stats Tracking on Github 
Follow [stats_request_docs](./docs/Request_Stats.md)

## Visualize stats with streamlit

```bash
pip install streamlit
streamlit run streamlit_app.py
```


            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "osmsg",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "osm, stats, commandline, openstreetmap",
    "author": null,
    "author_email": "Kshitij Raj Sharma <skshitizraj@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/58/57/f4932029eaae609aa6a27e11ce28354853fc9d494a5840664783f90bbb78/osmsg-0.3.0.tar.gz",
    "platform": null,
    "description": "# OpenStreetMap Stats Generator\n\nOn the Fly Commandline Stats Generator for OpenStreetMap User Contributions\n\nI tweet stats Every day/week/month for Global/Region and #hotosm hashtag at https://twitter.com/stats_osm and store them [OSMSG Stats Dir](https://github.com/kshitij-raj-sharma/OSMSG-stats/)\n\nMonitored stats are available under `stats`, Currently Bot monitors OSM as whole , hotosm hashtag , Nepal Country : weekly,monthly and yearly stats are stored in github and twitter. \n\n### Usage:\nFor installation & Local Setup follow [Installation](./docs/Installation.md)\n```\nosmsg [-h] [--start_date START_DATE] [--end_date END_DATE] [--username USERNAME]\n             [--password PASSWORD] [--timezone {Nepal,UTC}] [--name NAME]\n             [--country COUNTRY [COUNTRY ...]] [--tags TAGS [TAGS ...]]\n             [--hashtags HASHTAGS [HASHTAGS ...]] [--length LENGTH [LENGTH ...]] [--force]\n             [--field_mappers] [--meta] [--tm_stats] [--rows ROWS] [--users USERS [USERS ...]]\n             [--workers WORKERS] [--url URL [URL ...]] [--last_week] [--last_day] [--last_month]\n             [--last_year] [--last_hour] [--days DAYS] [--charts] [--summary] [--exact_lookup]\n             [--changeset] [--all_tags] [--temp]\n             [--format {csv,json,excel,image,text} [{csv,json,excel,image,text} ...]]\n             [--read_from_metadata READ_FROM_METADATA] [--boundary BOUNDARY] [--update]\n```\n\n### Options:\nHit following command for listing out the option with their documentation\n```\nosmsg --help\n```\n\n### Features\nIt is a python package that processes osm files live and produces stats on the fly\n\n1. It can Generate Stats on Country Level for countries based on geofabrik urls . Countries are available in [here](./data/countries.csv)\n2. It can also take any other server replication changefile to extract stats (Tested with Geofabrik and Planet Replication)\n3. Can Generate hashtag statistics\n4. Supports multiple output formats , Visualize Automatic Stats Being Genarated [here](./stats/)\n5. It can create summary charts automatically along with stats , Visualize them [here](./stats/Global/Daily/)\n6. Can generate stats for any custom timestamp provided\n\n```\n{\"name\":\"username\",\"uid\":uid,\"changesets\":1,\"nodes.create\":1071,\"nodes.modify\":2100,\"nodes.delete\":0,\"ways.create\":146,\"ways.modify\":69,\"ways.delete\":0,\"relations.create\":0,\"relations.modify\":1,\"relations.delete\":0,\"building.create\":138,\"building.modify\":11,\"building.delete\":0,\"highway.create\":5,\"highway.modify\":49,\"highway.delete\":0,\"waterway.create\":0,\"waterway.modify\":4,\"waterway.delete\":0,\"amenity.create\":0,\"amenity.modify\":3,\"amenity.delete\":0,\"landuse.create\":3,\"landuse.modify\":1,\"landuse.delete\":0,\"natural.create\":0,\"natural.modify\":3,\"natural.delete\":0,\"total_map_changes\":3387}\n```\n\n### Get Started :\n\n- Extract Stat of last hour and visualize stats/charts\n  \n  By default replication is minute url.\n\n```\nosmsg --last_hour\n```\n\n- With Hashtags information\n\n```\nosmsg --last_hour --changeset\n```\n\n  \n- Last week data with summary & all tags info and using day replication\n```\nosmsg --last_week --url day --summary --all_tags\n```\n\nFor More , Follow [Manual](./docs/Manual.md)\n\n### Contributing\nContributions are always welcome! Follow [Contributing Guidelines](./CONTRIBUTING.md) & Go through [Code of Conduct](./CODE_OF_CONDUCT.md)\n\n### Version Control\nFollow [Version Control Docs](./docs/Version_control.md)\n\n### Request Stats Tracking on Github \nFollow [stats_request_docs](./docs/Request_Stats.md)\n\n## Visualize stats with streamlit\n\n```bash\npip install streamlit\nstreamlit run streamlit_app.py\n```\n\n",
    "bugtrack_url": null,
    "license": "GPL-3.0-only",
    "summary": "OpenStreetMap Stats Generator: Commandline",
    "version": "0.3.0",
    "project_urls": {
        "documentation": "https://github.com/kshitijrajsharma/osmsg",
        "homepage": "https://github.com/kshitijrajsharma/osmsg",
        "repository": "https://github.com/kshitijrajsharma/osmsg"
    },
    "split_keywords": [
        "osm",
        " stats",
        " commandline",
        " openstreetmap"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "17d04f810556d94a32789080e980916a35a366e7b001887f9dbc95dd35ef3075",
                "md5": "78c5a641ffe82dd5d745c64059bc7d61",
                "sha256": "b77b282dbda616c5d03aab6bcfd7898a066503a6721f237f34fc1c0d3554d103"
            },
            "downloads": -1,
            "filename": "osmsg-0.3.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "78c5a641ffe82dd5d745c64059bc7d61",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 31440,
            "upload_time": "2024-08-26T13:32:12",
            "upload_time_iso_8601": "2024-08-26T13:32:12.900857Z",
            "url": "https://files.pythonhosted.org/packages/17/d0/4f810556d94a32789080e980916a35a366e7b001887f9dbc95dd35ef3075/osmsg-0.3.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5857f4932029eaae609aa6a27e11ce28354853fc9d494a5840664783f90bbb78",
                "md5": "2d49fe66c6ccbbc9ee3835477e05dce1",
                "sha256": "77ffe73dabd0b6b926fba5809147988a5a365b921a555599d096021424f279f0"
            },
            "downloads": -1,
            "filename": "osmsg-0.3.0.tar.gz",
            "has_sig": false,
            "md5_digest": "2d49fe66c6ccbbc9ee3835477e05dce1",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 28623,
            "upload_time": "2024-08-26T13:32:14",
            "upload_time_iso_8601": "2024-08-26T13:32:14.116598Z",
            "url": "https://files.pythonhosted.org/packages/58/57/f4932029eaae609aa6a27e11ce28354853fc9d494a5840664783f90bbb78/osmsg-0.3.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-26 13:32:14",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "kshitijrajsharma",
    "github_project": "osmsg",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "requests",
            "specs": []
        },
        {
            "name": "osmium",
            "specs": []
        },
        {
            "name": "pandas",
            "specs": [
                [
                    "==",
                    "1.5.2"
                ]
            ]
        },
        {
            "name": "tweepy",
            "specs": []
        },
        {
            "name": "Shapely",
            "specs": []
        },
        {
            "name": "geopandas",
            "specs": [
                [
                    "==",
                    "0.10.2"
                ]
            ]
        },
        {
            "name": "tqdm",
            "specs": []
        },
        {
            "name": "seaborn",
            "specs": []
        },
        {
            "name": "matplotlib",
            "specs": []
        },
        {
            "name": "humanize",
            "specs": []
        }
    ],
    "lcname": "osmsg"
}
        
Elapsed time: 0.70694s