flowgl

Name	flowgl JSON
Version	0.1.3 JSON
	download
home_page
Summary	Flow Immersive python client for datasets API
upload_time	2023-01-19 06:58:38
maintainer
docs_url	None
author	Flow Immersive
requires_python	>=3.8,<4.0
license
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Flow Immersive Python Client

An easy way to push data from pandas to Flow.

## Usage

Push data to Flow, identifying the dataset with a title. 
Pushing a new dataset with the same title will create a new dataset version.

```python
import pandas as pd

# Example pandas dataframe
df = pd.DataFrame({
    'name': ['John', 'Jane', 'Joe'],
    'age': [30, 25, 40],
    'city': ['New York', 'San Francisco', 'Los Angeles']
})

from flowgl import Client

# Import the client and create an instance with your credentials
client = Client(
    username=...,
    password=...,
)

# Push the dataframe to Flow by title
client.push_data(
    df,
    dataset_title='My Dataset',
)
```

## Development

### Installation

First, install python and poetry. If on Windows, ensure you add poetry's bin directory to your PATH environment variable (search for "environment variables" in the start menu).

Then, clone the repository and step into it.
```bash
git clone git@bitbucket.org:flowvr/flow-scripts.git
cd flow-scripts
```
#### Create Virtual Environment

Create a virtual environment (replace python with python3 or py as per your installation).

```bash
python -m venv venv
```

#### Activate Virtual Environment

This will activate the virtual environment for the current terminal session. You should see (venv) at the start of your terminal prompt.

On Windows Powershell:
```powershell
Set-ExecutionPolicy -ExecutionPolicy Bypass -Scope Process -Force
.\venv\Scripts\Activate.ps1
```

On Windows Command Prompt:
```cmd
.\venv\Scripts\activate.bat
```

On Mac/Linux/WSL:
```bash
source venv/bin/activate
```

#### Install Dependencies

Finally, install the dependencies with poetry.

```bash
poetry install
```

### Publishing

To publish a new version of the package, first update the version number in `pyproject.toml`.  
Then, run the following commands: 

```bash
poetry build
poetry publish
```

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "flowgl",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8,<4.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "Flow Immersive",
    "author_email": "info@flow.gl",
    "download_url": "https://files.pythonhosted.org/packages/c6/17/0eb019ffe023dd6379560b8857bb9d02773c64f49ff20a7c0f9c28a4503a/flowgl-0.1.3.tar.gz",
    "platform": null,
    "description": "# Flow Immersive Python Client\n\nAn easy way to push data from pandas to Flow.\n\n## Usage\n\nPush data to Flow, identifying the dataset with a title. \nPushing a new dataset with the same title will create a new dataset version.\n\n```python\nimport pandas as pd\n\n# Example pandas dataframe\ndf = pd.DataFrame({\n    'name': ['John', 'Jane', 'Joe'],\n    'age': [30, 25, 40],\n    'city': ['New York', 'San Francisco', 'Los Angeles']\n})\n\nfrom flowgl import Client\n\n# Import the client and create an instance with your credentials\nclient = Client(\n    username=...,\n    password=...,\n)\n\n# Push the dataframe to Flow by title\nclient.push_data(\n    df,\n    dataset_title='My Dataset',\n)\n```\n\n## Development\n\n### Installation\n\nFirst, install python and poetry. If on Windows, ensure you add poetry's bin directory to your PATH environment variable (search for \"environment variables\" in the start menu).\n\nThen, clone the repository and step into it.\n```bash\ngit clone git@bitbucket.org:flowvr/flow-scripts.git\ncd flow-scripts\n```\n#### Create Virtual Environment\n\nCreate a virtual environment (replace python with python3 or py as per your installation).\n\n```bash\npython -m venv venv\n```\n\n#### Activate Virtual Environment\n\nThis will activate the virtual environment for the current terminal session. You should see (venv) at the start of your terminal prompt.\n\nOn Windows Powershell:\n```powershell\nSet-ExecutionPolicy -ExecutionPolicy Bypass -Scope Process -Force\n.\\venv\\Scripts\\Activate.ps1\n```\n\nOn Windows Command Prompt:\n```cmd\n.\\venv\\Scripts\\activate.bat\n```\n\nOn Mac/Linux/WSL:\n```bash\nsource venv/bin/activate\n```\n\n#### Install Dependencies\n\nFinally, install the dependencies with poetry.\n\n```bash\npoetry install\n```\n\n### Publishing\n\nTo publish a new version of the package, first update the version number in `pyproject.toml`.  \nThen, run the following commands: \n\n```bash\npoetry build\npoetry publish\n```\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Flow Immersive python client for datasets API",
    "version": "0.1.3",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "96c3127565577e9030211d17b2e09e836c815b3b5d19ef8fd278ee2e0b19aa2d",
                "md5": "53c8be336bfc862ed600c98cd6a1345a",
                "sha256": "feac8ba3082168d9cda84323c9f16812d593870333722caa2d5d65ef864a5c0b"
            },
            "downloads": -1,
            "filename": "flowgl-0.1.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "53c8be336bfc862ed600c98cd6a1345a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8,<4.0",
            "size": 3005,
            "upload_time": "2023-01-19T06:58:37",
            "upload_time_iso_8601": "2023-01-19T06:58:37.003390Z",
            "url": "https://files.pythonhosted.org/packages/96/c3/127565577e9030211d17b2e09e836c815b3b5d19ef8fd278ee2e0b19aa2d/flowgl-0.1.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c6170eb019ffe023dd6379560b8857bb9d02773c64f49ff20a7c0f9c28a4503a",
                "md5": "3d5070853f4553c6a7f3b413c19c431b",
                "sha256": "f835d6a473314eaf7288f3990c25cc72250c862d9f516272569b660657df7414"
            },
            "downloads": -1,
            "filename": "flowgl-0.1.3.tar.gz",
            "has_sig": false,
            "md5_digest": "3d5070853f4553c6a7f3b413c19c431b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8,<4.0",
            "size": 3053,
            "upload_time": "2023-01-19T06:58:38",
            "upload_time_iso_8601": "2023-01-19T06:58:38.600849Z",
            "url": "https://files.pythonhosted.org/packages/c6/17/0eb019ffe023dd6379560b8857bb9d02773c64f49ff20a7c0f9c28a4503a/flowgl-0.1.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-01-19 06:58:38",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "flowgl"
}