spyndle-web-api

Name	spyndle-web-api JSON
Version	0.1.0 JSON
	download
home_page
Summary	A non-destructive Web API for Spyglass
upload_time	2024-01-24 17:35:52
maintainer
docs_url	None
author	Jeremy Magland
requires_python	>=3.9,<4.0
license
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Spyglass Web API

This is a web API for interacting with a Spyglass database. It is written in Python and uses FastAPI.

## Developer setup

Start a local spyglass instance. Instructions taken from [this notebook](https://github.com/LorenFrankLab/spyglass/blob/master/notebooks/00_Setup.ipynb).

```bash
# one time
docker pull datajoint/mysql:8.0
docker volume create dj-vol

# start the database
bash devel start-spyglass-database.sh
```

Clone spyglass and install it in development mode.

```bash
cd spyglass
pip install -e .
```

Configure spyglass.

```bash
cp dj_local_conf_example.json dj_local_conf.json
# Then edit dj_local_conf.json to set the database credentials and the directories for the data.

# Make sure to set "custom.no_prompts_mode": true, in the config file.
```

Set SPYGLASS_CONFIG_PATH to point to the spyglass config file, then run:

```bash
python devel/check-config.py
```

Install sgwa in development mode

```bash
pip install -e .
```

Start the web API.

```bash
# start the web API
bash devel/start-sgwa.sh
```

Check the database connection

```bash
python devel/check-db-connection.py
```
            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "spyndle-web-api",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9,<4.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "Jeremy Magland",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/d2/90/aa6115dc70cc093b95468418a9f0a1053115840f1f0256dc44f6e8a8bef7/spyndle_web_api-0.1.0.tar.gz",
    "platform": null,
    "description": "# Spyglass Web API\n\nThis is a web API for interacting with a Spyglass database. It is written in Python and uses FastAPI.\n\n## Developer setup\n\nStart a local spyglass instance. Instructions taken from [this notebook](https://github.com/LorenFrankLab/spyglass/blob/master/notebooks/00_Setup.ipynb).\n\n```bash\n# one time\ndocker pull datajoint/mysql:8.0\ndocker volume create dj-vol\n\n# start the database\nbash devel start-spyglass-database.sh\n```\n\nClone spyglass and install it in development mode.\n\n```bash\ncd spyglass\npip install -e .\n```\n\nConfigure spyglass.\n\n```bash\ncp dj_local_conf_example.json dj_local_conf.json\n# Then edit dj_local_conf.json to set the database credentials and the directories for the data.\n\n# Make sure to set \"custom.no_prompts_mode\": true, in the config file.\n```\n\nSet SPYGLASS_CONFIG_PATH to point to the spyglass config file, then run:\n\n```bash\npython devel/check-config.py\n```\n\nInstall sgwa in development mode\n\n```bash\npip install -e .\n```\n\nStart the web API.\n\n```bash\n# start the web API\nbash devel/start-sgwa.sh\n```\n\nCheck the database connection\n\n```bash\npython devel/check-db-connection.py\n```",
    "bugtrack_url": null,
    "license": "",
    "summary": "A non-destructive Web API for Spyglass",
    "version": "0.1.0",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "71a59d74487aa0ee4e7581952c2a3ebc17adc986fc08e90e0decb5f3542b41df",
                "md5": "db44357480ca56b0a9e7b58f4bc5cf96",
                "sha256": "51d1fc85137d208a09722c3b988dbb98bd9c7b9ac4843ae010067b3c7b0ac550"
            },
            "downloads": -1,
            "filename": "spyndle_web_api-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "db44357480ca56b0a9e7b58f4bc5cf96",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9,<4.0",
            "size": 6996,
            "upload_time": "2024-01-24T17:35:51",
            "upload_time_iso_8601": "2024-01-24T17:35:51.086482Z",
            "url": "https://files.pythonhosted.org/packages/71/a5/9d74487aa0ee4e7581952c2a3ebc17adc986fc08e90e0decb5f3542b41df/spyndle_web_api-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d290aa6115dc70cc093b95468418a9f0a1053115840f1f0256dc44f6e8a8bef7",
                "md5": "bafea8a352fab083be27d6689a5ab787",
                "sha256": "6488b64e4b1177013144460c5631e7081b12b9937ef6d77f9e5738b2fe23a3fd"
            },
            "downloads": -1,
            "filename": "spyndle_web_api-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "bafea8a352fab083be27d6689a5ab787",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9,<4.0",
            "size": 4993,
            "upload_time": "2024-01-24T17:35:52",
            "upload_time_iso_8601": "2024-01-24T17:35:52.770762Z",
            "url": "https://files.pythonhosted.org/packages/d2/90/aa6115dc70cc093b95468418a9f0a1053115840f1f0256dc44f6e8a8bef7/spyndle_web_api-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-01-24 17:35:52",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "spyndle-web-api"
}