tempres


Nametempres JSON
Version 0.0.2 PyPI version JSON
download
home_pagehttps://github.com/kr-g/tempres
Summarycollect temperature and pressure data from a mpy-modcore device
upload_time2023-03-11 10:03:36
maintainer
docs_urlNone
authork. goger
requires_python>=3.10
licenseother / AGPLv3+
keywords micropython esp32 esp8266 modcore home-automation
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            

# REPO ARCHIVED (2023-03-11)

this repo is archived and not maintained longer 


---

last version of tempres v0.0.2

---


[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

# tempres 

collect temperature and pressure data from a mpy-modcore device
running the `tempr` module


# what's new ?

Check
[`CHANGELOG`](https://github.com/kr-g/tempres/blob/main/CHANGELOG.md)
for latest ongoing, or upcoming news.


# limitations

Check 
[`BACKLOG`](https://github.com/kr-g/tempres/blob/main/BACKLOG.md)
for open development tasks and limitations.


# how to use

todo: documentation pending

following cmd-line tools are included in this package.


## tempres

`tempres` loads one data package from a device and stores it under `~/.tempres/inq` (default) as json.

use `tempres --help` to see all cmd-line options.


## tempresdb

imports the data from `~/.tempres/inq` into a sqlite db `~/.tempresdb`.

currently no further cmd-line options to configure the process (todo)


## tempresplt

plots the data "temperature and pressure data over time" from `~/.tempresdb` with mathplotlib.

currently no further cmd-line options to configure the process (todo)


## temprespub

interface to OpenWeatherMap.org 

- [one call api doc](https://openweathermap.org/api/one-call-3)
- [station api doc](https://openweathermap.org/stations#steps)


### cmd line parameters

todo documentation

### configuration

todo documentation

file `~/tempres/stations.json` 

    {
      "api_key" : "your-api-key",
      "stations" : [
        { 
          "station_id" : "your-id1",
          "name" : "your-name",
          "tag" : "a-tag",
          "zip_code" : 12456, # dummy value
          "country_code" : "de",
        },
        { 
          "station_id" : "your-id2",
          "name" : "your name 2",
          "tag" : "a second tag",
          "lat" : 1234, # dummy value
          "lon" : 215265, # dummy value
        }
      ]
    }

remark: `station_id` is mapped to openweathermap `external_id` field


# platform

tested on python3, and linux


# development status

alpha state, use on your own risk!


# installation

    phyton3 -m pip install tempres
    

# license

[`LICENSE`](https://github.com/kr-g/tempres/blob/main/LICENSE.md)



see [`BACKLOG`](https://github.com/kr-g/tempres/blob/main/BACKLOG.md)
for open development tasks and limitations.


# Changelog

## version v0.0.2 - 20230311

- added mathplot support with cmd-line `tempresplt`
- added openweathermap interface cmd-line `temprespub`
- last version of tempres, repo will be archived, no further development
- 


## version v0.0.1 - 20220608

- first release
- 

# BACKLOG

- housekeeping
  - insert only a sub directory instead of all
    - pattern patching for input files
  - delete temp_rec entries
  - 
- cmd line interface
  - tempresplt
  - tempresdb
- custom db engine creation
- temprespub
  - rework cmdline interface
-


# OPEN ISSUES

refer to [issues](https://github.com/kr-g/tempres/issues)


# LIMITATIONS

- only sqlite supported as db backend at the moment
- dont delete raw json data, keep it as a base for future db imports
- 
 




            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/kr-g/tempres",
    "name": "tempres",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": "",
    "keywords": "micropython esp32 esp8266 modcore home-automation",
    "author": "k. goger",
    "author_email": "k.r.goger+tempres@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/c7/4d/a61005e83566f8a2fb458ded080510dc49f6eab4297b8d6e78fdbbca146d/tempres-0.0.2.tar.gz",
    "platform": null,
    "description": "\n\n# REPO ARCHIVED (2023-03-11)\n\nthis repo is archived and not maintained longer \n\n\n---\n\nlast version of tempres v0.0.2\n\n---\n\n\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n\n# tempres \n\ncollect temperature and pressure data from a mpy-modcore device\nrunning the `tempr` module\n\n\n# what's new ?\n\nCheck\n[`CHANGELOG`](https://github.com/kr-g/tempres/blob/main/CHANGELOG.md)\nfor latest ongoing, or upcoming news.\n\n\n# limitations\n\nCheck \n[`BACKLOG`](https://github.com/kr-g/tempres/blob/main/BACKLOG.md)\nfor open development tasks and limitations.\n\n\n# how to use\n\ntodo: documentation pending\n\nfollowing cmd-line tools are included in this package.\n\n\n## tempres\n\n`tempres` loads one data package from a device and stores it under `~/.tempres/inq` (default) as json.\n\nuse `tempres --help` to see all cmd-line options.\n\n\n## tempresdb\n\nimports the data from `~/.tempres/inq` into a sqlite db `~/.tempresdb`.\n\ncurrently no further cmd-line options to configure the process (todo)\n\n\n## tempresplt\n\nplots the data \"temperature and pressure data over time\" from `~/.tempresdb` with mathplotlib.\n\ncurrently no further cmd-line options to configure the process (todo)\n\n\n## temprespub\n\ninterface to OpenWeatherMap.org \n\n- [one call api doc](https://openweathermap.org/api/one-call-3)\n- [station api doc](https://openweathermap.org/stations#steps)\n\n\n### cmd line parameters\n\ntodo documentation\n\n### configuration\n\ntodo documentation\n\nfile `~/tempres/stations.json` \n\n    {\n      \"api_key\" : \"your-api-key\",\n      \"stations\" : [\n        { \n          \"station_id\" : \"your-id1\",\n          \"name\" : \"your-name\",\n          \"tag\" : \"a-tag\",\n          \"zip_code\" : 12456, # dummy value\n          \"country_code\" : \"de\",\n        },\n        { \n          \"station_id\" : \"your-id2\",\n          \"name\" : \"your name 2\",\n          \"tag\" : \"a second tag\",\n          \"lat\" : 1234, # dummy value\n          \"lon\" : 215265, # dummy value\n        }\n      ]\n    }\n\nremark: `station_id` is mapped to openweathermap `external_id` field\n\n\n# platform\n\ntested on python3, and linux\n\n\n# development status\n\nalpha state, use on your own risk!\n\n\n# installation\n\n    phyton3 -m pip install tempres\n    \n\n# license\n\n[`LICENSE`](https://github.com/kr-g/tempres/blob/main/LICENSE.md)\n\n\n\nsee [`BACKLOG`](https://github.com/kr-g/tempres/blob/main/BACKLOG.md)\nfor open development tasks and limitations.\n\n\n# Changelog\n\n## version v0.0.2 - 20230311\n\n- added mathplot support with cmd-line `tempresplt`\n- added openweathermap interface cmd-line `temprespub`\n- last version of tempres, repo will be archived, no further development\n- \n\n\n## version v0.0.1 - 20220608\n\n- first release\n- \n\n# BACKLOG\n\n- housekeeping\n  - insert only a sub directory instead of all\n    - pattern patching for input files\n  - delete temp_rec entries\n  - \n- cmd line interface\n  - tempresplt\n  - tempresdb\n- custom db engine creation\n- temprespub\n  - rework cmdline interface\n-\n\n\n# OPEN ISSUES\n\nrefer to [issues](https://github.com/kr-g/tempres/issues)\n\n\n# LIMITATIONS\n\n- only sqlite supported as db backend at the moment\n- dont delete raw json data, keep it as a base for future db imports\n- \n \n\n\n\n",
    "bugtrack_url": null,
    "license": "other / AGPLv3+",
    "summary": "collect temperature and pressure data from a mpy-modcore device",
    "version": "0.0.2",
    "split_keywords": [
        "micropython",
        "esp32",
        "esp8266",
        "modcore",
        "home-automation"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "167403f77c528a5ea6894bf3252a934ba31cb025dabed4b8914bbca67468a4ef",
                "md5": "540aac73754956c79b77085f5662577a",
                "sha256": "03c93a4487ab295c3ff8b2a3c85b4fa07e18b0d928df2323ba35fc7ba1fb4357"
            },
            "downloads": -1,
            "filename": "tempres-0.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "540aac73754956c79b77085f5662577a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 24026,
            "upload_time": "2023-03-11T10:03:33",
            "upload_time_iso_8601": "2023-03-11T10:03:33.887566Z",
            "url": "https://files.pythonhosted.org/packages/16/74/03f77c528a5ea6894bf3252a934ba31cb025dabed4b8914bbca67468a4ef/tempres-0.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c74da61005e83566f8a2fb458ded080510dc49f6eab4297b8d6e78fdbbca146d",
                "md5": "a091b75453d4dfe9e58b39e9da20772d",
                "sha256": "7fcea2295d6de33b013a258c50465e3bc92a8210148f1ffa7a6bba7789f4faba"
            },
            "downloads": -1,
            "filename": "tempres-0.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "a091b75453d4dfe9e58b39e9da20772d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 24463,
            "upload_time": "2023-03-11T10:03:36",
            "upload_time_iso_8601": "2023-03-11T10:03:36.091393Z",
            "url": "https://files.pythonhosted.org/packages/c7/4d/a61005e83566f8a2fb458ded080510dc49f6eab4297b8d6e78fdbbca146d/tempres-0.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-03-11 10:03:36",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "kr-g",
    "github_project": "tempres",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "lcname": "tempres"
}
        
Elapsed time: 0.04363s