{"id":16411419,"url":"https://github.com/yetone/olo-stubs","last_synced_at":"2025-02-24T04:24:58.967Z","repository":{"id":146236667,"uuid":"234536708","full_name":"yetone/olo-stubs","owner":"yetone","description":"Mypy plugin and stubs for OLO ORM","archived":false,"fork":false,"pushed_at":"2020-10-15T06:42:35.000Z","size":71,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-17T07:50:03.049Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yetone.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-01-17T11:40:42.000Z","updated_at":"2020-10-15T06:42:37.000Z","dependencies_parsed_at":null,"dependency_job_id":"5f8ee59f-90be-4a8b-9a6f-5eee97defda9","html_url":"https://github.com/yetone/olo-stubs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yetone%2Folo-stubs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yetone%2Folo-stubs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yetone%2Folo-stubs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yetone%2Folo-stubs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yetone","download_url":"https://codeload.github.com/yetone/olo-stubs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240416789,"owners_count":19797881,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-11T06:45:28.023Z","updated_at":"2025-02-24T04:24:58.929Z","avatar_url":"https://github.com/yetone.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cimg src=\"http://mypy-lang.org/static/mypy_light.svg\" alt=\"mypy logo\" width=\"300px\"/\u003e\n\nMypy plugin and stubs for [OLO](https://github.com/yetone/olo) inspired by [sqlalchemy-stubs](https://github.com/dropbox/sqlalchemy-stubs)\n====================================\n\n[![Build Status](https://travis-ci.org/yetone/olo-stubs.svg?branch=master)](https://travis-ci.org/yetone/olo-stubs)\n[![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)\n\nThis package contains [type stubs](https://www.python.org/dev/peps/pep-0561/) and a\n[mypy plugin](https://mypy.readthedocs.io/en/latest/extending_mypy.html#extending-mypy-using-plugins)\nto provide more precise static types and type inference for\n[OLO framework](https://github.com/yetone/olo). A simple example:\n\n```python\nfrom olo import Model, Field\n\nclass BaseModel(Model):\n    pass\n\nclass User(BaseModel):\n    __table_name__ = 'users'\n    id = Field(int, primary_key=True)\n    name = Field(str)\n\nuser: User\nreveal_type(user.id)  # N: Revealed type is 'builtins.int*'\nreveal_type(User.name)  # N: Revealed type is 'olo.field.Field[builtins.str]'\n```\n\n## Installation\nInstall latest published version as:\n```\npip install -U olo-stubs\n```\n\n*Important*: you need to enable the plugin in your mypy config file:\n```\n[mypy]\nplugins = olomypy\n```\n\nTo install the development version of the package:\n```\ngit clone https://github.com/yetone/olo-stubs\ncd olo-stubs\npip install -U .\n```\n\n## Development Setup\n\nFirst, clone the repo and cd into it, like in _Installation_, then:\n```\ngit submodule update --init --recursive\npip install -r dev-requirements.txt\n```\n\nThen, to run the tests, simply:\n```\npytest\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyetone%2Folo-stubs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyetone%2Folo-stubs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyetone%2Folo-stubs/lists"}