machine-learning-model-local 0.0.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,95 @@
1
+ Metadata-Version: 2.1
2
+ Name: machine-learning-model-local
3
+ Version: 0.0.1
4
+ Summary: PyPI Package for Circles machine-learning-model-local Python
5
+ Home-page: https://github.com/circles
6
+ Author: Circles
7
+ Author-email: info@circlez.ai
8
+ Classifier: Programming Language :: Python :: 3
9
+ Classifier: License :: Other/Proprietary License
10
+ Classifier: Operating System :: OS Independent
11
+ Description-Content-Type: text/markdown
12
+ Requires-Dist: logger-local>=0.0.61
13
+ Requires-Dist: database-without-orm-local>=0.0.90
14
+
15
+ # python-package-template
16
+ This repository is designed to help you create local and remote package layers in Python.
17
+ It focuses on building package layers and does not include GraphQL and REST-API layers.
18
+
19
+ ## Download Environment
20
+ To set up the environment, follow these steps in your terminal:
21
+ ```shell
22
+ git clone https://github.com/circles-zone/<your-repo>.git --branch dev # or other branch
23
+ cd <your-repo>
24
+ git checkout -b BU-<new-branch> # if a new branch is needed
25
+ python -m venv venv
26
+ pip install -r requirements.txt
27
+ ... <edit your code> ...
28
+ git add .
29
+ git commit -m "Your commit message"
30
+ git push origin BU-<your-branch>
31
+ ```
32
+
33
+ For more detailed information, refer to the [documentation](https://docs.google.com/document/d/1HKhwlhwLD3S8uJ9LPI7h4Nxu77-DXKZe/edit?usp=sharing&ouid=104468990154530891864&rtpof=true&sd=true).
34
+
35
+ ## Check List:
36
+
37
+ ### Directory Structure
38
+
39
+ Ensure that the root directory has the following structure:
40
+ - `.github/`
41
+ - `.vscode/` (optional)
42
+ - `directory_with_same_name_as_the_repo/`
43
+ - `db/`
44
+ - `reports/`
45
+ - `project_name/`
46
+ - `src/`
47
+ - `__init__.py`
48
+ - `example_class.py`
49
+ - `tests/`
50
+ - `example_class_test.py`
51
+ - `__init__.py`
52
+
53
+ This setup enables easy switching to a mono repo configuration.
54
+
55
+ ### Database Python Scripts
56
+
57
+ Place `<table-name>.py` in the `/db` folder if needed.
58
+ There's no need for a separate file for `_ml` tables.
59
+ Feel free to delete the example file if it's not required.
60
+
61
+ ### Database Schema and Data
62
+
63
+ - Create files to define the database schema, tables, views, and populate metadata and test data.
64
+ - Use `/db/<table-name>.py` to create the schema, tables, views (including `_ml_table`).
65
+ - Use `/db/<table-name>_insert.py` to create metadata and test data records.
66
+
67
+ ### Update `setup.py`
68
+
69
+ Don't forget to update the `setup.py` file, including the package name and version.
70
+ Remember to upload the version after every deployment.
71
+ ### Working with VS Code
72
+ Ensure that you push the `launch.json` file to the repository.
73
+ This enables running and debugging the code smoothly.
74
+
75
+ ### Unit Testing
76
+ We recommend using `pytest` over the `unittest` package.
77
+ Create a `pytest.ini` file in the project directory, not the root directory.
78
+ run in termianl: pytest
79
+
80
+ ## Workflow Completion
81
+ When you've addressed all the TODOs in the repository, using infrastructure classes like Logger, Database, Url, Importer, and others, make sure your Feature Branch GitHub Actions Workflow is green without warnings.
82
+ All tests should run in GitHub Actions, your code should be well-documented, the `README.md` file should be clear and self-explanatory, test coverage should be above 90%, and all lines of code should be covered by unit tests.
83
+
84
+ Once these conditions are met, you can filter and analyze your records in Logz.io.
85
+ Pull the `dev` branch to your Feature Branch and then create a Pull Request to `dev`.
86
+
87
+ Good luck :)
88
+
89
+ ## check your code visibility lint with flake (Mandatory before pusj):
90
+ run those command
91
+ python -m pip install flake8 pytest
92
+ flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
93
+ flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
94
+
95
+ note: you should use autopep8 extension in your code!
@@ -0,0 +1,81 @@
1
+ # python-package-template
2
+ This repository is designed to help you create local and remote package layers in Python.
3
+ It focuses on building package layers and does not include GraphQL and REST-API layers.
4
+
5
+ ## Download Environment
6
+ To set up the environment, follow these steps in your terminal:
7
+ ```shell
8
+ git clone https://github.com/circles-zone/<your-repo>.git --branch dev # or other branch
9
+ cd <your-repo>
10
+ git checkout -b BU-<new-branch> # if a new branch is needed
11
+ python -m venv venv
12
+ pip install -r requirements.txt
13
+ ... <edit your code> ...
14
+ git add .
15
+ git commit -m "Your commit message"
16
+ git push origin BU-<your-branch>
17
+ ```
18
+
19
+ For more detailed information, refer to the [documentation](https://docs.google.com/document/d/1HKhwlhwLD3S8uJ9LPI7h4Nxu77-DXKZe/edit?usp=sharing&ouid=104468990154530891864&rtpof=true&sd=true).
20
+
21
+ ## Check List:
22
+
23
+ ### Directory Structure
24
+
25
+ Ensure that the root directory has the following structure:
26
+ - `.github/`
27
+ - `.vscode/` (optional)
28
+ - `directory_with_same_name_as_the_repo/`
29
+ - `db/`
30
+ - `reports/`
31
+ - `project_name/`
32
+ - `src/`
33
+ - `__init__.py`
34
+ - `example_class.py`
35
+ - `tests/`
36
+ - `example_class_test.py`
37
+ - `__init__.py`
38
+
39
+ This setup enables easy switching to a mono repo configuration.
40
+
41
+ ### Database Python Scripts
42
+
43
+ Place `<table-name>.py` in the `/db` folder if needed.
44
+ There's no need for a separate file for `_ml` tables.
45
+ Feel free to delete the example file if it's not required.
46
+
47
+ ### Database Schema and Data
48
+
49
+ - Create files to define the database schema, tables, views, and populate metadata and test data.
50
+ - Use `/db/<table-name>.py` to create the schema, tables, views (including `_ml_table`).
51
+ - Use `/db/<table-name>_insert.py` to create metadata and test data records.
52
+
53
+ ### Update `setup.py`
54
+
55
+ Don't forget to update the `setup.py` file, including the package name and version.
56
+ Remember to upload the version after every deployment.
57
+ ### Working with VS Code
58
+ Ensure that you push the `launch.json` file to the repository.
59
+ This enables running and debugging the code smoothly.
60
+
61
+ ### Unit Testing
62
+ We recommend using `pytest` over the `unittest` package.
63
+ Create a `pytest.ini` file in the project directory, not the root directory.
64
+ run in termianl: pytest
65
+
66
+ ## Workflow Completion
67
+ When you've addressed all the TODOs in the repository, using infrastructure classes like Logger, Database, Url, Importer, and others, make sure your Feature Branch GitHub Actions Workflow is green without warnings.
68
+ All tests should run in GitHub Actions, your code should be well-documented, the `README.md` file should be clear and self-explanatory, test coverage should be above 90%, and all lines of code should be covered by unit tests.
69
+
70
+ Once these conditions are met, you can filter and analyze your records in Logz.io.
71
+ Pull the `dev` branch to your Feature Branch and then create a Pull Request to `dev`.
72
+
73
+ Good luck :)
74
+
75
+ ## check your code visibility lint with flake (Mandatory before pusj):
76
+ run those command
77
+ python -m pip install flake8 pytest
78
+ flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
79
+ flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
80
+
81
+ note: you should use autopep8 extension in your code!
@@ -0,0 +1,27 @@
1
+ # TODO: This is an example file which you should delete after implementing
2
+ from dotenv import load_dotenv
3
+
4
+ from circles_local_database_python.connector import Connector
5
+ from circles_local_database_python.generic_crud import GenericCRUD
6
+ from logger_local.Logger import Logger
7
+ from logger_local.LoggerComponentEnum import LoggerComponentEnum
8
+
9
+ load_dotenv()
10
+
11
+ # Setup the logger: change YOUR_REPOSITORY variable name and value
12
+ # YOUR_REPOSITORY_COMPONENT_ID = 0 # ask your team leader for this integer
13
+ # YOUR_REPOSITORY_COMPONENT_NAME = "Enter you repository name"
14
+ # DEVELOPER_EMAIL = "Enter you circlez.ai email"
15
+ # object1 = {
16
+ # 'component_id': YOUR_REPOSITORY_COMPONENT_ID,
17
+ # 'component_name': YOUR_REPOSITORY_COMPONENT_NAME,
18
+ # 'component_category': LoggerComponentEnum.ComponentCategory.Code.value,
19
+ # 'developer_email': DEVELOPER_EMAIL
20
+ # }
21
+ # logger=Logger.create_logger(object=object1)
22
+
23
+ class ExampleClass(GenericCRUD):
24
+ def __init__(self) -> None:
25
+ pass
26
+
27
+
@@ -0,0 +1,95 @@
1
+ Metadata-Version: 2.1
2
+ Name: machine-learning-model-local
3
+ Version: 0.0.1
4
+ Summary: PyPI Package for Circles machine-learning-model-local Python
5
+ Home-page: https://github.com/circles
6
+ Author: Circles
7
+ Author-email: info@circlez.ai
8
+ Classifier: Programming Language :: Python :: 3
9
+ Classifier: License :: Other/Proprietary License
10
+ Classifier: Operating System :: OS Independent
11
+ Description-Content-Type: text/markdown
12
+ Requires-Dist: logger-local>=0.0.61
13
+ Requires-Dist: database-without-orm-local>=0.0.90
14
+
15
+ # python-package-template
16
+ This repository is designed to help you create local and remote package layers in Python.
17
+ It focuses on building package layers and does not include GraphQL and REST-API layers.
18
+
19
+ ## Download Environment
20
+ To set up the environment, follow these steps in your terminal:
21
+ ```shell
22
+ git clone https://github.com/circles-zone/<your-repo>.git --branch dev # or other branch
23
+ cd <your-repo>
24
+ git checkout -b BU-<new-branch> # if a new branch is needed
25
+ python -m venv venv
26
+ pip install -r requirements.txt
27
+ ... <edit your code> ...
28
+ git add .
29
+ git commit -m "Your commit message"
30
+ git push origin BU-<your-branch>
31
+ ```
32
+
33
+ For more detailed information, refer to the [documentation](https://docs.google.com/document/d/1HKhwlhwLD3S8uJ9LPI7h4Nxu77-DXKZe/edit?usp=sharing&ouid=104468990154530891864&rtpof=true&sd=true).
34
+
35
+ ## Check List:
36
+
37
+ ### Directory Structure
38
+
39
+ Ensure that the root directory has the following structure:
40
+ - `.github/`
41
+ - `.vscode/` (optional)
42
+ - `directory_with_same_name_as_the_repo/`
43
+ - `db/`
44
+ - `reports/`
45
+ - `project_name/`
46
+ - `src/`
47
+ - `__init__.py`
48
+ - `example_class.py`
49
+ - `tests/`
50
+ - `example_class_test.py`
51
+ - `__init__.py`
52
+
53
+ This setup enables easy switching to a mono repo configuration.
54
+
55
+ ### Database Python Scripts
56
+
57
+ Place `<table-name>.py` in the `/db` folder if needed.
58
+ There's no need for a separate file for `_ml` tables.
59
+ Feel free to delete the example file if it's not required.
60
+
61
+ ### Database Schema and Data
62
+
63
+ - Create files to define the database schema, tables, views, and populate metadata and test data.
64
+ - Use `/db/<table-name>.py` to create the schema, tables, views (including `_ml_table`).
65
+ - Use `/db/<table-name>_insert.py` to create metadata and test data records.
66
+
67
+ ### Update `setup.py`
68
+
69
+ Don't forget to update the `setup.py` file, including the package name and version.
70
+ Remember to upload the version after every deployment.
71
+ ### Working with VS Code
72
+ Ensure that you push the `launch.json` file to the repository.
73
+ This enables running and debugging the code smoothly.
74
+
75
+ ### Unit Testing
76
+ We recommend using `pytest` over the `unittest` package.
77
+ Create a `pytest.ini` file in the project directory, not the root directory.
78
+ run in termianl: pytest
79
+
80
+ ## Workflow Completion
81
+ When you've addressed all the TODOs in the repository, using infrastructure classes like Logger, Database, Url, Importer, and others, make sure your Feature Branch GitHub Actions Workflow is green without warnings.
82
+ All tests should run in GitHub Actions, your code should be well-documented, the `README.md` file should be clear and self-explanatory, test coverage should be above 90%, and all lines of code should be covered by unit tests.
83
+
84
+ Once these conditions are met, you can filter and analyze your records in Logz.io.
85
+ Pull the `dev` branch to your Feature Branch and then create a Pull Request to `dev`.
86
+
87
+ Good luck :)
88
+
89
+ ## check your code visibility lint with flake (Mandatory before pusj):
90
+ run those command
91
+ python -m pip install flake8 pytest
92
+ flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
93
+ flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
94
+
95
+ note: you should use autopep8 extension in your code!
@@ -0,0 +1,10 @@
1
+ README.md
2
+ pyproject.toml
3
+ setup.py
4
+ machine_learning_model_local.egg-info/PKG-INFO
5
+ machine_learning_model_local.egg-info/SOURCES.txt
6
+ machine_learning_model_local.egg-info/dependency_links.txt
7
+ machine_learning_model_local.egg-info/requires.txt
8
+ machine_learning_model_local.egg-info/top_level.txt
9
+ machine_learning_model_local/src/__init__.py
10
+ machine_learning_model_local/src/machine_learning_model.py
@@ -0,0 +1,2 @@
1
+ logger-local>=0.0.61
2
+ database-without-orm-local>=0.0.90
@@ -0,0 +1,19 @@
1
+ # This file should be in the future instead of setup.py
2
+ # https://python-poetry.org/docs/pyproject
3
+
4
+ # It seems we need to copy this file also to serverless-com repo, as required by dialog-workflow-python-package
5
+
6
+ [build-system]
7
+ requires = ["setuptools>=61.0"]
8
+ build-backend = "setuptools.build_meta"
9
+
10
+ [tool.poetry]
11
+ # TODO: Please update the name, similar to storage-local (suffix -local)
12
+ name = "machine-learning-model-local"
13
+ # I believe we are still using the version from setup.py and not from here until potery will work
14
+ version = "0.0.1" # https://pypi.org/project/machine-learning-model-local
15
+ description = "machine-learning-model-local-Python Package"
16
+ readme = "README.md"
17
+ authors = [
18
+ "Circlez.ai <info@circlez.ai>",
19
+ ]
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+
@@ -0,0 +1,39 @@
1
+ import setuptools
2
+ # Each Python project should have pyproject.toml or setup.py (if both exist, we use the setup.py)
3
+ # TODO: Please create pyproject.toml instead of setup.py (delete the setup.py)
4
+ # used by python -m build
5
+ # ```python -m build``` needs pyproject.toml or setup.py
6
+ # The need for setup.py is changing as of poetry 1.1.0 (including current pre-release) as we have moved away from needing to generate a setup.py file to enable editable installs - We might able to delete this file in the near future
7
+
8
+ PACKAGE_NAME = "machine-learning-model-local"
9
+ package_dir = PACKAGE_NAME.replace("-", "_")
10
+
11
+ with open('README.md') as f:
12
+ readme = f.read()
13
+
14
+ setuptools.setup(
15
+ # TODO: Please update the name and delete this line i.e. XXX-local or XXX-remote (without the -python-package suffix). Only lowercase, no underlines.
16
+ name=PACKAGE_NAME,
17
+ version='0.0.1', # update each time
18
+ author="Circles",
19
+ author_email="info@circlez.ai",
20
+ # TODO: Please update the description and delete this line
21
+ description="PyPI Package for Circles machine-learning-model-local Python",
22
+ long_description=open('README.md').read(),
23
+ long_description_content_type='text/markdown',
24
+ # TODO: Please update the URL below
25
+ url="https://github.com/circles", # https://pypi.org/project/machine-learning-model-local/
26
+ packages=[package_dir],
27
+ package_dir={package_dir: f'{package_dir}/src'},
28
+ package_data={package_dir: ['*.py']},
29
+ classifiers=[
30
+ "Programming Language :: Python :: 3",
31
+ "License :: Other/Proprietary License",
32
+ "Operating System :: OS Independent",
33
+ ],
34
+ # TODO: Update which packages to include with this package
35
+ install_requires=[
36
+ 'logger-local>= 0.0.61',
37
+ 'database-without-orm-local>=0.0.90'
38
+ ],
39
+ )