squirrels 0.4.0__py3-none-any.whl → 0.5.0__py3-none-any.whl

squirrels/project.py

@@ -1,378 +0,0 @@
-import typing as _t, functools as _ft, asyncio as _aio, os as _os, shutil as _shutil, json as _json
-import logging as _l, uuid as _uu, matplotlib.pyplot as _plt, networkx as _nx, pandas as _pd
-
-from . import _utils as _u, _constants as _c, _environcfg as _ec, _manifest as _mf, _authenticator as _auth
-from . import _seeds as _s, _connection_set as _cs, _models as _m, _dashboards_io as _d, _parameter_sets as _ps
-from . import dashboards as _dash
-
-T = _t.TypeVar('T', bound=_dash.Dashboard)
-
-
-class _CustomJsonFormatter(_l.Formatter):
-    def format(self, record: _l.LogRecord) -> str:
-        super().format(record)
-        info = {
-            "timestamp": self.formatTime(record),
-            "project_id": record.name,
-            "level": record.levelname,
-            "message": record.getMessage(),
-            "thread": record.thread,
-            "thread_name": record.threadName,
-            "process": record.process,
-            **record.__dict__.get("info", {})
-        }
-        output = {
-            "data": record.__dict__.get("data", {}),
-            "info": info
-        }
-        return _json.dumps(output)
-
-
-class SquirrelsProject:
-    """
-    Initiate an instance of this class to interact with a Squirrels project through Python code. For example this can be handy to experiment with the datasets produced by Squirrels in a Jupyter notebook.
-    """
-    
-    def __init__(self, *, filepath: str = ".", log_file: str | None = _c.LOGS_FILE, log_level: str = "INFO", log_format: str = "text") -> None:
-        """
-        Constructor for SquirrelsProject class. Loads the file contents of the Squirrels project into memory as member fields.
-
-        Arguments:
-            filepath: The path to the Squirrels project file. Defaults to the current working directory.
-            log_level: The logging level to use. Options are "DEBUG", "INFO", and "WARNING". Default is "INFO".
-            log_file: The name of the log file to write to from the "logs/" subfolder. If None or empty string, then file logging is disabled. Default is "squirrels.log".
-            log_format: The format of the log records. Options are "text" and "json". Default is "text".
-        """
-        self._filepath = filepath
-        self._logger = self._get_logger(self._filepath, log_file, log_level, log_format)
-    
-    def _get_logger(self, base_path: str, log_file: str | None, log_level: str, log_format: str) -> _u.Logger:
-        logger = _u.Logger(name=_uu.uuid4().hex)
-        logger.setLevel(log_level.upper())
-        
-        if log_file:
-            path = _u.Path(base_path, _c.LOGS_FOLDER, log_file)
-            path.parent.mkdir(parents=True, exist_ok=True)
-
-            handler = _l.FileHandler(path)
-            if log_format.lower() == "json":
-                handler.setFormatter(_CustomJsonFormatter())
-            elif log_format.lower() == "text":
-                formatter = _l.Formatter("[%(name)s] %(asctime)s - %(levelname)s - %(message)s")
-                handler.setFormatter(formatter)
-            else:
-                raise ValueError("log_format must be either 'text' or 'json'")
-            logger.addHandler(handler)
-        else:
-            logger.disabled = True
-        
-        return logger
-    
-    @property
-    @_ft.cache
-    def _env_cfg(self) -> _ec.EnvironConfig:
-        return _ec.EnvironConfigIO.load_from_file(self._logger, self._filepath)
-
-    @property
-    @_ft.cache
-    def _manifest_cfg(self) -> _mf.ManifestConfig:
-        return _mf.ManifestIO.load_from_file(self._logger, self._filepath, self._env_cfg)
-    
-    @property
-    @_ft.cache
-    def _seeds(self) -> _s.Seeds:
-        return _s.SeedsIO.load_files(self._logger, self._filepath, self._manifest_cfg)
-    
-    @property
-    @_ft.cache
-    def _model_files(self) -> dict[str, _m.QueryFile]:
-        return _m.ModelsIO.load_files(self._logger, self._filepath)
-    
-    @property
-    @_ft.cache
-    def _context_func(self) -> _m.ContextFunc:
-        return _m.ModelsIO.load_context_func(self._logger, self._filepath)
-    
-    @property
-    @_ft.cache
-    def _dashboards(self) -> dict[str, _d.DashboardFunction]:
-        return _d.DashboardsIO.load_files(self._logger, self._filepath)
-    
-    @property
-    @_ft.cache
-    def _conn_args(self) -> _cs.ConnectionsArgs:
-        return _cs.ConnectionSetIO.load_conn_py_args(self._logger, self._env_cfg, self._manifest_cfg)
-    
-    @property
-    def _conn_set(self) -> _cs.ConnectionSet:
-        if not hasattr(self, "__conn_set") or self.__conn_set is None:
-            self.__conn_set = _cs.ConnectionSetIO.load_from_file(self._logger, self._filepath, self._manifest_cfg, self._conn_args)
-        return self.__conn_set
-    
-    @property
-    @_ft.cache
-    def _authenticator(self) -> _auth.Authenticator:
-        token_expiry_minutes = self._manifest_cfg.settings.get(_c.AUTH_TOKEN_EXPIRE_SETTING, 30)
-        return _auth.Authenticator(self._filepath, self._env_cfg, self._conn_args, self._conn_set, token_expiry_minutes)
-    
-    @property
-    @_ft.cache
-    def _param_args(self) -> _ps.ParametersArgs:
-        return _ps.ParameterConfigsSetIO.get_param_args(self._conn_args)
-    
-    @property
-    @_ft.cache
-    def _param_cfg_set(self) -> _ps.ParameterConfigsSet:
-        return _ps.ParameterConfigsSetIO.load_from_file(
-            self._logger, self._filepath, self._manifest_cfg, self._seeds, self._conn_set, self._param_args
-        )
-    
-    @property
-    @_ft.cache
-    def _j2_env(self) -> _u.EnvironmentWithMacros:
-        return _u.EnvironmentWithMacros(self._logger, loader=_u.j2.FileSystemLoader(self._filepath))
-    
-    @property
-    @_ft.cache
-    def User(self) -> type[_auth.User]:
-        """
-        A direct reference to the User class in the `auth.py` file (if applicable). If `auth.py` does not exist, then this returns the `squirrels.User` class.
-        """
-        return self._authenticator.user_cls
-    
-    def close(self) -> None:
-        """
-        Deliberately close any open resources within the Squirrels project, such as database connections (instead of relying on the garbage collector).
-        """
-        if hasattr(self, "__conn_set") and self.__conn_set is not None:
-            self.__conn_set.dispose()
-            self.__conn_set = None
-
-    def __exit__(self, exc_type, exc_val, traceback):
-        self.close()
-    
-    def _generate_dag(self, dataset: str, *, target_model_name: str | None = None, always_pandas: bool = False) -> _m.DAG:
-        seeds_dict = self._seeds.get_dataframes()
-
-        models_dict: dict[str, _m.Referable] = {key: _m.Seed(key, df) for key, df in seeds_dict.items()}
-        for key, val in self._model_files.items():
-            models_dict[key] = _m.Model(key, val, self._manifest_cfg, self._conn_set, self._logger, j2_env=self._j2_env)
-            models_dict[key].needs_pandas = always_pandas
-        
-        dataset_config = self._manifest_cfg.datasets[dataset]
-        target_model_name = dataset_config.model if target_model_name is None else target_model_name
-        target_model = models_dict[target_model_name]
-        target_model.is_target = True
-        
-        return _m.DAG(self._manifest_cfg, dataset_config, target_model, models_dict, self._logger)
-    
-    def _draw_dag(self, dag: _m.DAG, output_folder: _u.Path) -> None:
-        color_map = {_m.ModelType.SEED: "green", _m.ModelType.DBVIEW: "red", _m.ModelType.FEDERATE: "skyblue"}
-
-        G = dag.to_networkx_graph()
-        
-        fig, _ = _plt.subplots()
-        pos = _nx.multipartite_layout(G, subset_key="layer")
-        colors = [color_map[node[1]] for node in G.nodes(data="model_type")] # type: ignore
-        _nx.draw(G, pos=pos, node_shape='^', node_size=1000, node_color=colors, arrowsize=20)
-        
-        y_values = [val[1] for val in pos.values()]
-        scale = max(y_values) - min(y_values) if len(y_values) > 0 else 0
-        label_pos = {key: (val[0], val[1]-0.002-0.1*scale) for key, val in pos.items()}
-        _nx.draw_networkx_labels(G, pos=label_pos, font_size=8)
-        
-        fig.tight_layout()
-        _plt.margins(x=0.1, y=0.1)
-        fig.savefig(_u.Path(output_folder, "dag.png"))
-        _plt.close(fig)
-
-    async def _write_dataset_outputs_given_test_set(
-        self, dataset: str, select: str, test_set: str | None, runquery: bool, recurse: bool
-    ) -> _t.Any | None:
-        dataset_conf = self._manifest_cfg.datasets[dataset]
-        default_test_set_conf = self._manifest_cfg.get_default_test_set(dataset)
-        if test_set in self._manifest_cfg.selection_test_sets:
-            test_set_conf = self._manifest_cfg.selection_test_sets[test_set]
-        elif test_set is None or test_set == default_test_set_conf.name:
-            test_set, test_set_conf = default_test_set_conf.name, default_test_set_conf
-        else:
-            raise _u.ConfigurationError(f"No test set named '{test_set}' was found when compiling dataset '{dataset}'. The test set must be defined if not default for dataset.")
-        
-        error_msg_intro = f"Cannot compile dataset '{dataset}' with test set '{test_set}'."
-        if test_set_conf.datasets is not None and dataset not in test_set_conf.datasets:
-            raise _u.ConfigurationError(f"{error_msg_intro}\n Applicable datasets for test set '{test_set}' does not include dataset '{dataset}'.")
-        
-        user_attributes = test_set_conf.user_attributes.copy()
-        selections = test_set_conf.parameters.copy()
-        username, is_internal = user_attributes.pop("username", ""), user_attributes.pop("is_internal", False)
-        if test_set_conf.is_authenticated:
-            user = self.User.Create(username, is_internal=is_internal, **user_attributes)
-        elif dataset_conf.scope == _mf.DatasetScope.PUBLIC:
-            user = None
-        else:
-            raise _u.ConfigurationError(f"{error_msg_intro}\n Non-public datasets require a test set with 'user_attributes' section defined")
-        
-        if dataset_conf.scope == _mf.DatasetScope.PRIVATE and not is_internal:
-            raise _u.ConfigurationError(f"{error_msg_intro}\n Private datasets require a test set with user_attribute 'is_internal' set to true")
-
-        # always_pandas is set to True for creating CSV files from results (when runquery is True)
-        dag = self._generate_dag(dataset, target_model_name=select, always_pandas=True)
-        placeholders = await dag.execute(self._param_args, self._param_cfg_set, self._context_func, user, selections, runquery=runquery, recurse=recurse)
-        
-        output_folder = _u.Path(self._filepath, _c.TARGET_FOLDER, _c.COMPILE_FOLDER, dataset, test_set)
-        if _os.path.exists(output_folder):
-            _shutil.rmtree(output_folder)
-        _os.makedirs(output_folder, exist_ok=True)
-        
-        def write_placeholders() -> None:
-            output_filepath = _u.Path(output_folder, "placeholders.json")
-            with open(output_filepath, 'w') as f:
-                _json.dump(placeholders, f, indent=4)
-        
-        def write_model_outputs(model: _m.Referable) -> None:
-            assert isinstance(model, _m.Model)
-            subfolder = _c.DBVIEWS_FOLDER if model.query_file.model_type == _m.ModelType.DBVIEW else _c.FEDERATES_FOLDER
-            subpath = _u.Path(output_folder, subfolder)
-            _os.makedirs(subpath, exist_ok=True)
-            if isinstance(model.compiled_query, _m.SqlModelQuery):
-                output_filepath = _u.Path(subpath, model.name+'.sql')
-                query = model.compiled_query.query
-                with open(output_filepath, 'w') as f:
-                    f.write(query)
-            if runquery and isinstance(model.result, _pd.DataFrame):
-                output_filepath = _u.Path(subpath, model.name+'.csv')
-                model.result.to_csv(output_filepath, index=False)
-
-        write_placeholders()
-        all_model_names = dag.get_all_query_models()
-        coroutines = [_aio.to_thread(write_model_outputs, dag.models_dict[name]) for name in all_model_names]
-        await _aio.gather(*coroutines)
-
-        if recurse:
-            self._draw_dag(dag, output_folder)
-        
-        if isinstance(dag.target_model, _m.Model) and dag.target_model.compiled_query is not None:
-            return dag.target_model.compiled_query.query # else return None
-    
-    async def compile(
-        self, *, dataset: str | None = None, do_all_datasets: bool = False, selected_model: str | None = None, test_set: str | None = None, 
-        do_all_test_sets: bool = False, runquery: bool = False
-    ) -> None:
-        """
-        Async method to compile the SQL templates into files in the "target/" folder. Same functionality as the "sqrl compile" CLI.
-
-        Although all arguments are "optional", the "dataset" argument is required if "do_all_datasets" argument is False.
-
-        Arguments:
-            dataset: The name of the dataset to compile. Ignored if "do_all_datasets" argument is True, but required (i.e., cannot be None) if "do_all_datasets" is False. Default is None.
-            do_all_datasets: If True, compile all datasets and ignore the "dataset" argument. Default is False.
-            selected_model: The name of the model to compile. If specified, the compiled SQL query is also printed in the terminal. If None, all models for the selected dataset are compiled. Default is None.
-            test_set: The name of the test set to compile with. If None, the default test set is used (which can vary by dataset). Ignored if `do_all_test_sets` argument is True. Default is None.
-            do_all_test_sets: Whether to compile all applicable test sets for the selected dataset(s). If True, the `test_set` argument is ignored. Default is False.
-            runquery**: Whether to run all compiled queries and save each result as a CSV file. If True and `selected_model` is specified, all upstream models of the selected model is compiled as well. Default is False.
-        """
-        recurse = True
-        if do_all_datasets:
-            selected_models = [(dataset.name, dataset.model) for dataset in self._manifest_cfg.datasets.values()]
-        else:
-            assert isinstance(dataset, str), "argument 'dataset' must be provided a string value if argument 'do_all_datasets' is False"
-            assert dataset in self._manifest_cfg.datasets, f"dataset '{dataset}' not found in {_c.MANIFEST_FILE}"
-            if selected_model is None:
-                selected_model = self._manifest_cfg.datasets[dataset].model
-            else:
-                recurse = False
-            selected_models = [(dataset, selected_model)]
-        
-        coroutines: list[_t.Coroutine] = []
-        for dataset, selected_model in selected_models:
-            if do_all_test_sets:
-                for test_set_name in self._manifest_cfg.get_applicable_test_sets(dataset):
-                    coroutine = self._write_dataset_outputs_given_test_set(dataset, selected_model, test_set_name, runquery, recurse)
-                    coroutines.append(coroutine)
-            
-            coroutine = self._write_dataset_outputs_given_test_set(dataset, selected_model, test_set, runquery, recurse)
-            coroutines.append(coroutine)
-        
-        queries = await _aio.gather(*coroutines)
-        
-        print(f"Compiled successfully! See the '{_c.TARGET_FOLDER}/' folder for results.")
-        print()
-        if not recurse and len(queries) == 1 and isinstance(queries[0], str):
-            print(queries[0])
-            print()
-
-    def _permission_error(self, user: _auth.User | None, data_type: str, data_name: str, scope: str) -> PermissionError:
-        username = None if user is None else user.username
-        return PermissionError(f"User '{username}' does not have permission to access {scope} {data_type}: {data_name}")
-    
-    def seed(self, name: str) -> _pd.DataFrame:
-        """
-        Method to retrieve a seed as a pandas DataFrame given a seed name.
-
-        Arguments:
-            name: The name of the seed to retrieve
-
-        Returns:
-            The seed as a pandas DataFrame
-        """
-        seeds_dict = self._seeds.get_dataframes()
-        try:
-            return seeds_dict[name]
-        except KeyError:
-            available_seeds = list(seeds_dict.keys())
-            raise KeyError(f"Seed '{name}' not found. Available seeds are: {available_seeds}")
-    
-    async def _dataset_helper(
-        self, name: str, selections: dict[str, _t.Any], user: _auth.User | None
-    ) -> _pd.DataFrame:
-        dag = self._generate_dag(name)
-        await dag.execute(self._param_args, self._param_cfg_set, self._context_func, user, dict(selections))
-        return _pd.DataFrame(dag.target_model.result)
-    
-    async def dataset(
-        self, name: str, *, selections: dict[str, _t.Any] = {}, user: _auth.User | None = None
-    ) -> _pd.DataFrame:
-        """
-        Async method to retrieve a dataset as a pandas DataFrame given parameter selections.
-
-        Arguments:
-            name: The name of the dataset to retrieve.
-            selections: A dictionary of parameter selections to apply to the dataset. Optional, default is empty dictionary.
-            user: The user to use for authentication. If None, no user is used. Optional, default is None.
-        
-        Returns:
-            A pandas DataFrame containing the dataset.
-        """
-        scope = self._manifest_cfg.datasets[name].scope
-        if not self._authenticator.can_user_access_scope(user, scope):
-            raise self._permission_error(user, "dataset", name, scope.name)
-        return await self._dataset_helper(name, selections, user)
-    
-    async def dashboard(
-        self, name: str, *, selections: dict[str, _t.Any] = {}, user: _auth.User | None = None, dashboard_type: _t.Type[T] = _dash.Dashboard
-    ) -> T:
-        """
-        Async method to retrieve a dashboard given parameter selections.
-
-        Arguments:
-            name: The name of the dashboard to retrieve.
-            selections: A dictionary of parameter selections to apply to the dashboard. Optional, default is empty dictionary.
-            user: The user to use for authentication. If None, no user is used. Optional, default is None.
-            dashboard_type: Return type of the method (mainly used for type hints). For instance, provide PngDashboard if you want the return type to be a PngDashboard. Optional, default is squirrels.Dashboard.
-        
-        Returns:
-            The dashboard type specified by the "dashboard_type" argument.
-        """
-        scope = self._manifest_cfg.dashboards[name].scope
-        if not self._authenticator.can_user_access_scope(user, scope):
-            raise self._permission_error(user, "dashboard", name, scope.name)
-        
-        async def get_dataset(dataset_name: str, fixed_params: dict[str, _t.Any]) -> _pd.DataFrame:
-            final_selections = {**selections, **fixed_params}
-            return await self._dataset_helper(dataset_name, final_selections, user)
-        
-        args = _d.DashboardArgs(self._param_args.proj_vars, self._param_args.env_vars, get_dataset)
-        try:
-            return await self._dashboards[name].get_dashboard(args, dashboard_type=dashboard_type)
-        except KeyError:
-            raise KeyError(f"No dashboard file found for: {name}")

squirrels/user_base.py

@@ -1,55 +0,0 @@
-import typing as _t, dataclasses as _dc
-
-
-@_dc.dataclass
-class User:
-    """
-    Base class for extending the custom User model class
-
-    Attributes:
-        username: The identifier for the user
-        is_internal: Setting this to True lets the user access "private" datasets
-    """
-    username: str
-    is_internal: bool
-    
-    def __hash__(self) -> int:
-        return hash(self.username)
-    
-    def set_attributes(self, **kwargs) -> None:
-        """
-        Can be overwritten in "auth.py" to introduce custom attributes. Does nothing by default
-        """
-        pass
-    
-    @classmethod
-    def Create(cls, username: str, *, is_internal: bool = False, **kwargs):
-        """
-        Creates an instance of the User class and calls the `set_attributes` method on the new instance.
-
-        We may overwrite the `set_attributes` method in `auth.py`. We do not overwrite the constructor to guarantee that `username` and `is_internal` are always set.
-
-        Arguments:
-            username: The identifier for the user
-            is_internal: Setting this to True lets the user access "private" datasets. Default is False
-        """
-        user = cls(username, is_internal)
-        user.set_attributes(**kwargs)
-        return user
-    
-    @classmethod
-    def _FromDict(cls, user_obj_as_dict: dict[str, _t.Any]):
-        username, is_internal = user_obj_as_dict["username"], user_obj_as_dict["is_internal"]
-        user = cls(username=username, is_internal=is_internal)
-        for key, val in user_obj_as_dict.items():
-            setattr(user, key, val)
-        return user
-
-
-@_dc.dataclass
-class WrongPassword:
-    """
-    Return this object if the username was found but the password was incorrect
-
-    This ensures that if the username exists as a real user, we won't continue to use the env.yml file to authenticate
-    """

squirrels-0.4.0.dist-info/METADATA

@@ -1,117 +0,0 @@
-Metadata-Version: 2.1
-Name: squirrels
-Version: 0.4.0
-Summary: Squirrels - API Framework for Data Analytics
-Home-page: https://squirrels-analytics.github.io
-License: Apache-2.0
-Author: Tim Huang
-Author-email: tim.yuting@hotmail.com
-Requires-Python: >=3.10,<4.0
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Classifier: Typing :: Typed
-Provides-Extra: duckdb
-Requires-Dist: cachetools (>=5.3.2,<6.0.0)
-Requires-Dist: duckdb-engine (>=0.13.0,<1.0.0) ; extra == "duckdb"
-Requires-Dist: fastapi (>=0.112.1,<0.113.0)
-Requires-Dist: gitpython (>=3.1.41,<4.0.0)
-Requires-Dist: inquirer (>=3.2.1,<4.0.0)
-Requires-Dist: jinja2 (>=3.1.3,<4.0.0)
-Requires-Dist: matplotlib (>=3.8.3,<4.0.0)
-Requires-Dist: networkx (>=3.2.1,<4.0.0)
-Requires-Dist: pandas (>=2.1.4,<3.0.0)
-Requires-Dist: pydantic (>=2.8.2,<3.0.0)
-Requires-Dist: pyjwt (>=2.8.0,<3.0.0)
-Requires-Dist: python-multipart (>=0.0.9,<0.0.10)
-Requires-Dist: pyyaml (>=6.0.1,<7.0.0)
-Requires-Dist: sqlalchemy (>=2.0.25,<3.0.0)
-Requires-Dist: uvicorn (>=0.30.6,<0.31.0)
-Project-URL: Documentation, https://squirrels-analytics.github.io
-Project-URL: Repository, https://github.com/squirrels-analytics/squirrels
-Description-Content-Type: text/markdown
-
-# Squirrels
-
-Squirrels is an API framework that lets you create REST APIs for dynamic data analytics!
-
-**Documentation**: <a href="https://squirrels-analytics.github.io/" target="_blank">https://squirrels-analytics.github.io/</a>
-
-**Source Code**: <a href="https://github.com/squirrels-analytics/squirrels" target="_blank">https://github.com/squirrels-analytics/squirrels</a>
-
-## Table of Contents
-
-- [Main Features](#main-features)
-- [License](#license)
-- [Contributing to squirrels](#contributing-to-squirrels)
-    - [Setup](#setup)
-    - [Testing](#testing)
-    - [Project Structure](#project-structure)
-
-## Main Features
-
-Here are a few of the things that squirrels can do:
-
-- Connect to any database by specifying its SQLAlchemy url (in `squirrels.yml`) or by using its native connector library in python (in `connections.py`).
-- Configure API routes for datasets (in `squirrels.yml`) without writing code.
-- Configure parameter widgets (types include single-select, multi-select, date, number, etc.) for your datasets (in `parameters.py`).
-- Use Jinja SQL templates (just like dbt!) or python functions (that return a pandas dataframe) to define dynamic query logic based on parameter selections.
-- Query multiple databases and join the results together in a final view in one API endpoint/dataset!
-- Test your API endpoints with an interactive UI or by a command line that generates rendered sql queries and results (for a given set of parameter selections).
-- Define authentication logic (in `auth.py`) and authorize privacy scope per dataset (in `squirrels.yml`). The user's attributes can even be used in your query logic!
-
-## License
-
-Squirrels is released under the Apache 2.0 license.
-
-See the file LICENSE for more details.
-
-## Contributing to squirrels
-
-The sections below describe how to set up your local environment for squirrels development and run unit tests. A high level overview of the project structure is also provided.
-
-### Setup
-
-This project requires python version 3.10 or above to be installed. It also uses the python build tool `poetry`. Information on setting up poetry can be found at: https://python-poetry.org/docs/.
-
-Then, to install all dependencies, run:
-
-```
-poetry install
-```
-
-And activate the virtual environment created by poetry with:
-
-```
-poetry shell
-```
-
-To confirm that the setup worked, run the following to show the help page for all squirrels CLI commands:
-
-```bash
-sqrl -h
-```
-
-You can enter `exit` to exit the virtual environment shell. You can also run `poetry run sqrl -h` to run squirrels commands without activating the virtual environment.
-
-### Testing
-
-In poetry's virtual environment, run `pytest`.
-
-### Project Structure
-
-From the root of the git repo, the source code can be found in the `squirrels` folder and unit tests can be found in the `tests` folder.
-
-To understand what a specific squirrels command is doing, start from the `_command_line.py` file as your entry point.
-
-The library version is maintained in both the `pyproject.toml` and the `squirrels/_version.py` files.
-
-When a user initializes a squirrels project using `sqrl init`, the files are copied from the `squirrels/package_data/base_project` folder. The contents in the `database` subfolder were constructed from the scripts in the `database_elt` folder.
-
-For the Squirrels UI activated by `sqrl run`, the HTML, CSS, and Javascript files can be found in the `static` and `templates` subfolders of `squirrels/package_data`. The CSS and Javascript files are minified and built from the source files in this project: https://github.com/squirrels-analytics/squirrels-testing-ui.
-

squirrels-0.4.0.dist-info/RECORD

@@ -1,60 +0,0 @@
-squirrels/__init__.py,sha256=EbovxLpc9QcDooaME7887ur1lSjouWS36sealX_QOoo,946
-squirrels/_api_response_models.py,sha256=dHATCC80lJyQNRHhnCbG1uMWWOinxPfkq7YIG4GqD1I,9786
-squirrels/_api_server.py,sha256=GLn31Ki7gSxvYIOnVCp6wzZkuDT1MjHKnvhBEsasnB0,30902
-squirrels/_authenticator.py,sha256=21BADaTQ-ZfnTZMXTfNYiZFntTdm8QfRsh7X8tFJ3mA,4038
-squirrels/_command_line.py,sha256=UzD3B6JJY9rBzb2WBCNsOwUkBWaSFz0zZnsaHATp7qU,8115
-squirrels/_connection_set.py,sha256=oH5qp6PZwkLANCUEKkjKASe80V8SLK98-ZBaPtbUCpk,2867
-squirrels/_constants.py,sha256=k0KF2VIIvzeyfR1ycAwDR8uHZYfQJSBho90GbTRnvIM,2983
-squirrels/_dashboards_io.py,sha256=Qf2ow2hI57NRGtNB0rxtXy7XoNVxkvKuAFnVRxslLqY,2417
-squirrels/_environcfg.py,sha256=rAgDpJ4-h4yzFEbSG6gKh2XbQO3pAULB6Vo-66QAYp8,2875
-squirrels/_initializer.py,sha256=OzPEnb3uN_lf4o5bCA_r9I9D3XHD2-v-27d6trEjMjE,9809
-squirrels/_manifest.py,sha256=9DpDidPbKJ5GvXeW31fcg4nL7tRu8hqLmkBRbimep24,7626
-squirrels/_models.py,sha256=1Th1Vl_a1ddxjAGHCwq5sqx7RQsi5wYyyNUpRYvTx18,23641
-squirrels/_package_loader.py,sha256=DugsBkmm6OP8KPcJxmtuAMFnhf7t43rCRPjXXSwHXGs,1041
-squirrels/_parameter_configs.py,sha256=NF7ChgkAVlsTFrL5QkhEbsIbohcSFfuu4IvhxDRao0s,24731
-squirrels/_parameter_sets.py,sha256=YwyDp-8_VuKUPZ3oS9JWC9ynFlWy2sbiRDSXTGDBc4c,9702
-squirrels/_py_module.py,sha256=w4AYGrks121_osRxL9F8hiX0ZuPXC6krnJB8cOqhWBI,2564
-squirrels/_seeds.py,sha256=gLMlDphnwQKzSWLjpQBGYNPy5XtS0xu2PReqkk55na4,1462
-squirrels/_utils.py,sha256=ykV3hjQTxG9-blmAPxCfd78bJXR1YfH_rQdUBsTaRJM,8829
-squirrels/_version.py,sha256=vsjw-CsgmLFBE8OTwqlzxn_6L-jeLXsXgAlWcncGcJs,105
-squirrels/arguments/init_time_args.py,sha256=Rc6n9vVZ7p4WpbyAvryG-tGb4vRQKrRyfRdzy3w5WTc,925
-squirrels/arguments/run_time_args.py,sha256=Dk3H-iPlsy4i3swAVs8Uk6yyQPko7CEb9acfqHnzcvc,7031
-squirrels/dashboards.py,sha256=NeLcBxfIOJV-hlBllQ4mB4sSHFxAF-odjyiioUF19z4,1978
-squirrels/data_sources.py,sha256=qPtH5JFtCd8axjrXa40UlsZHU3geWTzxIkw3UAjj8lA,30019
-squirrels/dateutils.py,sha256=dvbXf9-VEt8PhDnY3rd6kjqFgVkWPOhsfsq8cq9kHdE,16734
-squirrels/package_data/assets/favicon.ico,sha256=FZx26dn50cp0rgYdyBptJJob2TTVNiY0NZ-MeeL_uY0,61022
-squirrels/package_data/assets/index.css,sha256=BJVYY2dse9-vhASMsls6j5gpf33Z9tCzR1VyX1rWkH0,12181
-squirrels/package_data/assets/index.js,sha256=TJDFw8B5OCGdvU9pFbf2BXKVOmtDNMTdSdCY4xK2QUM,265433
-squirrels/package_data/base_project/.gitignore,sha256=x7VR530sbdKJU83mF9OGD8b-nI92MbWqUnMPyB0Xz4U,137
-squirrels/package_data/base_project/assets/expenses.db,sha256=47ichjBqC25th7B0G5rz_yYJ4V3uQeF3cnttekQYa68,28672
-squirrels/package_data/base_project/assets/weather.db,sha256=dsHPO36gQdZ4ULAA726Hg3jp8a1dCdig1DhrGg8wTeg,86016
-squirrels/package_data/base_project/connections.yml,sha256=-rR6kjWl8FyHTzf2RnPqR1JEfhpX_pBrOJUxf5grRQY,259
-squirrels/package_data/base_project/dashboards/dashboard_example.py,sha256=pAvxMdrKT_-7cFcRH7qqVIaQs1oFXCg5PEwiwCi0xdY,1781
-squirrels/package_data/base_project/dashboards.yml,sha256=UEa9YI8ymi3tH15357oCWF5ZynNmyG2yu8B2F5Cr6d4,158
-squirrels/package_data/base_project/docker/.dockerignore,sha256=0BJ26C2eyVJPwbW1e4cmBg1TPADio4tqakd3hdojsq8,176
-squirrels/package_data/base_project/docker/Dockerfile,sha256=Sz4g9liLD40ci2iG2ohTjth3kvmNaCAo2LWZl6mCGR8,474
-squirrels/package_data/base_project/docker/compose.yml,sha256=u-P7Zh7IRfYAcebx4zE119OWn2m_TugGMh1IgPDl_2g,111
-squirrels/package_data/base_project/env.yml,sha256=5BUtjX8JEkVbtp7Xj-V-KcBkBJ6GEV1n05vasDSEYxw,943
-squirrels/package_data/base_project/models/dbviews/dbview_example.py,sha256=Kx32kJFqmwJSu519nqls0cDuN8h_YnuyxAcD_eLeNWk,2036
-squirrels/package_data/base_project/models/dbviews/dbview_example.sql,sha256=BJGTU25fdwCDXSEMFvXjn5Lnfi_Gu0wY2nir-d5VvUo,747
-squirrels/package_data/base_project/models/federates/federate_example.py,sha256=rLPA8UTpQN_vbCQcID22QWfI1Mu7s_Xly76medWq7DQ,712
-squirrels/package_data/base_project/models/federates/federate_example.sql,sha256=bHK1k8Q0uc2tZI21cw1y-w1w6Ah9dKRHRDwWVd80_Tk,75
-squirrels/package_data/base_project/parameters.yml,sha256=UUZoip-_X9axROZ9v_j-CkrUS-0x5lI0Kq02cRAkym8,6397
-squirrels/package_data/base_project/pyconfigs/auth.py,sha256=GyV84-lSfn0uGSP_kjvEFIHJCs3II3m97cYBYYYoQSc,1553
-squirrels/package_data/base_project/pyconfigs/connections.py,sha256=yb46igO8qH64tYczf0SJDtqyqxq5CANutzfKMtNJ96k,753
-squirrels/package_data/base_project/pyconfigs/context.py,sha256=tXQvdiHtESiHJup3yAkaKIuAEgFnV8H-Bz35VlqxIE0,3977
-squirrels/package_data/base_project/pyconfigs/parameters.py,sha256=5liqj98vLUus0kQGo4ae29ncr6zUpopNTXPhcnE3E5M,4940
-squirrels/package_data/base_project/seeds/seed_categories.csv,sha256=jppjf1nOIxy7-bi5lJn5CVqmnLfJHHq0ABgp6UqbXnw,104
-squirrels/package_data/base_project/seeds/seed_subcategories.csv,sha256=aZkBJ6KioyYjEwRunYiA8ec0X1ygiEmLRVicJecFzfY,327
-squirrels/package_data/base_project/squirrels.yml.j2,sha256=OhYjBjDLRtCWhSiAssslGrX5MsHQO8jC6HKz_NFnR_w,3076
-squirrels/package_data/base_project/tmp/.gitignore,sha256=XImoqcWvJY0C0L_TWCx1ljvqU7qh9fUTJmK4ACCmNFI,13
-squirrels/package_data/templates/index.html,sha256=41kyznAFLnE41IdPDCFdIvYLe7MgbIGrPOugk4YNXkQ,617
-squirrels/parameter_options.py,sha256=cWYKNoBUopHq6VfaeBu-nN2V0_IY3OgYpmYhKODNCew,16956
-squirrels/parameters.py,sha256=aSciLRxjY_-07VAv9mGxFQnhtjnuk4XT43MhZwVfoFY,56018
-squirrels/project.py,sha256=LxQbSOjEWdq5ZCj2u-03qMX1WJqKBk1_GPb3nCmsU0U,19256
-squirrels/user_base.py,sha256=gFtdi9K6RJovfKqRU-b-L1bOSdgNYQCQgfez3hz9EOo,1852
-squirrels-0.4.0.dist-info/LICENSE,sha256=CItkBKs5m4J5jhkjXoW7IAnFyOC86x4hyOATpczUMmM,11338
-squirrels-0.4.0.dist-info/METADATA,sha256=33BPbXUJCx3RAqa_yYWYAQw_g5APL2FaA7FdiQI_7rI,5217
-squirrels-0.4.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-squirrels-0.4.0.dist-info/entry_points.txt,sha256=mYQRuGxbg8X82hjNRJuWiON4S6kE5CPvmXmxNPtYTbg,92
-squirrels-0.4.0.dist-info/RECORD,,

squirrels-0.4.0.dist-info/entry_points.txt

@@ -1,4 +0,0 @@
-[console_scripts]
-sqrl=squirrels._command_line:main
-squirrels=squirrels._command_line:main
-