Metadata-Version: 2.4
Name: skolo
Version: 0.1.7
Summary: A command line tool and python package for SkoloCFD
Home-page: https://skolocfd.com/docs?topic=Api
Author: Skolo, LLC
Author-email: support@skolocfd.com
License: MIT License
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests>=2.25.1
Requires-Dist: python-dateutil>=2
Requires-Dist: packaging>=20
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary


The API for SkoloCFD
============================

skolo is the SkoloCFD Software Development Kit (SDK) for Python


Getting Started
---------------
You can install the library on linux using ``pip``

    $ python -m pip install skolo

Or from the windows command prompt with:

    $ py -m pip install skolo

Or, assuming that you have Python and ``virtualenv`` installed, set up your environment and install the required dependencies like this:

    $ git clone https://github.com/skoloCFD/skolo
    $ cd skolo
    $ virtualenv venv
    ...
    $ . venv/bin/activate
    $ python -m pip install -r requirements.txt
    $ python -m pip install -e .



Configuring Skolo
------------
After installing skolo, you'll need to provide it credential access to the Skolo web server. Instructions for this can be found on the documentation page of the website.

Credentials are bearer tokens and should be readable only by your user account. On Linux and macOS, store them under ``~/.skolo/skolo.credentials`` with mode ``600``:

    $ chmod 600 ~/.skolo/skolo.credentials

Local development mode uses a separate low-scope token file, ``~/.skolo/skolo.local.credentials``, and never falls back to production credentials. Do not copy production tokens into the local credentials file.

If you use ``~/.skolo/config`` to override the server, the client only accepts ``skolocfd.com`` hosts over HTTPS, or localhost/loopback hosts for local development.


Release Notes
------------
####v0.1.7 - Bug fixes, ANSA support
- improved upload behavior with parallel uploads, better server validation, and clearer HTTP error handling
- added beta ANSA button integration for exporting visible/all PIDs to ``geomConstruction``

####v0.1.6 - Upload support
- added geometry upload support, including folders, files, and quoted glob patterns

####v0.1.5 - Bearer tokens and geometry routing
- switched API authentication to bearer tokens
- improved URL parsing, redirects, rate-limit handling, and server error messages
- updated geometry routing, geomPrep, and geomCompare behavior
- added support for ``latest`` as a baseline run when creating cases

####v0.1.4 - December 2024
- new options for creating cases
- ability to connect to the Skolo server or localhost development servers
