python-flask-dev 0.0.1__tar.gz

python_flask_dev-0.0.1/PKG-INFO

@@ -0,0 +1,201 @@
+Metadata-Version: 2.4
+Name: python-flask-dev
+Version: 0.0.1
+Summary: Package containing modules with 'helper' functions to support the development of Python Flask applications.
+Author-email: Dani <daniasestan@gmail.com>
+License-Expression: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Framework :: Flask
+Requires-Python: >=3.12.3
+Description-Content-Type: text/markdown
+Requires-Dist: Flask==3.1.2
+Requires-Dist: numpy==2.4.2
+Requires-Dist: pandas==3.0.1
+Requires-Dist: build==1.4.0
+Requires-Dist: twine==6.2.0
+
+## Python Flask Dev
+
+## Table of contents
+
+1. Project description
+2. Project setup
+3. Contributing guidelines
+4. Project documentation
+5. Links to support resources
+6. Terms of use
+
+## Project description
+
+### What kind of software is this?
+
+Package containing modules with 'helper' functions to support the development of Python Flask applications.
+
+__________________
+
+### Who can use this app?
+
+Python Flask App Developer
+
+__________________
+
+### Project overview
+
+Language(s): [Python](https://www.python.org/)
+
+Framework(s): [Python Flask Framework](https://flask.palletsprojects.com/en/stable/)
+
+Style guide(s):
+[Python PEP 8](https://www.python.org/dev/peps/pep-0008)
+
+## Project setup
+
+### Pre-requisites
+
+Before using {Project name}, install necessary pkgs:
+
+* [PKG_NAME](https://www.python.org/downloads/)
+* [...]
+
+### Requirements
+
+GitHub will automatically not push any tokens.
+
+However, to commit any changes the .gitignore file must include any files that contain credentials.
+
+If the Markdown Changelog Generator is used, it needs to include  'changelog_generator.toml' because it lists your GitHub repo's PAT (Personal Access Token). 
+
+#### Install Python Flask Dev
+
+1. {Write the step here.}
+
+   {Explanatory text here}
+
+   {Optional: Include a code sample or screenshot that helps your users complete this step}
+
+2. {Write the step here.}
+
+   a. {Substep 1}
+
+   b. {Substep 2}
+
+#### Configure Python Flask Dev
+
+1. {Write the step here.}
+2. {Write the step here.}
+
+#### Run Python Flask Dev
+
+1. {Write the step here.}
+2. {Write the step here.}
+
+#### Troubleshoot Python Flask Dev
+
+1. {Write the step here.}
+2. {Write the step here.}
+
+<table>
+  <tr>
+   <td>
+    Issue
+   </td>
+   <td>
+    Solution
+   </td>
+  </tr>
+  <tr>
+   <td>
+    {Describe the issue here}
+   </td>
+   <td>
+    {Write solution here}
+   </td>
+  </tr>
+  <tr>
+   <td>
+    {Describe the issue here}
+   </td>
+   <td>
+    {Write solution here}
+   </td>
+  </tr>
+  <tr>
+   <td>
+    {Describe the issue here}
+   </td>
+   <td>
+    {Write solution here}
+   </td>
+  </tr>
+</table>
+
+Other troubleshooting support:
+
+* {Link to FAQs}
+* {Link to runbooks}
+* {Link to other relevant support information}
+
+### Recommendations
+
+* When working through a smaller project such as a program or a software application, a Changelog is recommended.
+
+Changelog entries typically follow a basic format that includes information about the code that was added to enhance a project, removed for any purpose, and modified to resolve errors.
+
+Changelog entries are entered in the CHANGELOG file once code is committed to the main branch:
+
+### [VERSION #] - [TIMESTAMP]
+
+#### [ADDED || REMOVED || FIXED]
+
+\<DESCRIPTION\>
+
+___
+
+### Version Control Process
+I. **Create a Feature Branch**
+Any code updates for a version change -- [Major].[Minor].[Patch] -- should be on a separate branch, referred to as a 'feature' branch.
+
+Once work on the branch is completed, a pull-request can be created to merge the branch into `dev`, a staging/pre-release branch, where those changes are tested.
+
+Once the staging branch is tested, stable code can be merged into `main` a production/release branch.
+
+________________
+##### Maintaining repos
+
+###### Branch Naming Conventions
+
+`<VERSION-RELEASE-#>/<FEATURE_NAME>/<CONTRIBUTOR>`
+
+- `<VERSION-RELEASE-#>`: Refer to [SemVer](https://semver.org/) for details
+
+- `<FEATURE_NAME>`: Descriptive title for the feature
+
+- `<CONTRIBUTOR>`: GitHub account name, e.g., https://github.com/<NAME>
+
+IV. **Documenting changes**
+
+Maintaining a CHANGELOG file is always recommended for a quick overview of how the project is progressing.
+1. Checkout main locally.
+2. From a terminal session, run the commands to use the GitHub ChangeLog Generator.
+3. Commit the CHANGELOG file to the remote branch.
+
+`changelog-generator-md`
+
+## Project documentation
+
+### Standard project docs are located in the `{PROJECT_ROOT}` folder.
+
+- README
+- LICENSE
+- CHANGELOG
+    - Refer to the Project dependencies section of the README for more information on generating a CHANGELOG file
+
+## Links
+
+* [<LINK>](<URL>): <LINK_DESC>
+* [...]
+
+## Terms of use
+
+Python Flask Dev is licensed under [MIT](https://commons.wikimedia.org/wiki/Template:X11)

python_flask_dev-0.0.1/README.md

@@ -0,0 +1,184 @@
+## Python Flask Dev
+
+## Table of contents
+
+1. Project description
+2. Project setup
+3. Contributing guidelines
+4. Project documentation
+5. Links to support resources
+6. Terms of use
+
+## Project description
+
+### What kind of software is this?
+
+Package containing modules with 'helper' functions to support the development of Python Flask applications.
+
+__________________
+
+### Who can use this app?
+
+Python Flask App Developer
+
+__________________
+
+### Project overview
+
+Language(s): [Python](https://www.python.org/)
+
+Framework(s): [Python Flask Framework](https://flask.palletsprojects.com/en/stable/)
+
+Style guide(s):
+[Python PEP 8](https://www.python.org/dev/peps/pep-0008)
+
+## Project setup
+
+### Pre-requisites
+
+Before using {Project name}, install necessary pkgs:
+
+* [PKG_NAME](https://www.python.org/downloads/)
+* [...]
+
+### Requirements
+
+GitHub will automatically not push any tokens.
+
+However, to commit any changes the .gitignore file must include any files that contain credentials.
+
+If the Markdown Changelog Generator is used, it needs to include  'changelog_generator.toml' because it lists your GitHub repo's PAT (Personal Access Token). 
+
+#### Install Python Flask Dev
+
+1. {Write the step here.}
+
+   {Explanatory text here}
+
+   {Optional: Include a code sample or screenshot that helps your users complete this step}
+
+2. {Write the step here.}
+
+   a. {Substep 1}
+
+   b. {Substep 2}
+
+#### Configure Python Flask Dev
+
+1. {Write the step here.}
+2. {Write the step here.}
+
+#### Run Python Flask Dev
+
+1. {Write the step here.}
+2. {Write the step here.}
+
+#### Troubleshoot Python Flask Dev
+
+1. {Write the step here.}
+2. {Write the step here.}
+
+<table>
+  <tr>
+   <td>
+    Issue
+   </td>
+   <td>
+    Solution
+   </td>
+  </tr>
+  <tr>
+   <td>
+    {Describe the issue here}
+   </td>
+   <td>
+    {Write solution here}
+   </td>
+  </tr>
+  <tr>
+   <td>
+    {Describe the issue here}
+   </td>
+   <td>
+    {Write solution here}
+   </td>
+  </tr>
+  <tr>
+   <td>
+    {Describe the issue here}
+   </td>
+   <td>
+    {Write solution here}
+   </td>
+  </tr>
+</table>
+
+Other troubleshooting support:
+
+* {Link to FAQs}
+* {Link to runbooks}
+* {Link to other relevant support information}
+
+### Recommendations
+
+* When working through a smaller project such as a program or a software application, a Changelog is recommended.
+
+Changelog entries typically follow a basic format that includes information about the code that was added to enhance a project, removed for any purpose, and modified to resolve errors.
+
+Changelog entries are entered in the CHANGELOG file once code is committed to the main branch:
+
+### [VERSION #] - [TIMESTAMP]
+
+#### [ADDED || REMOVED || FIXED]
+
+\<DESCRIPTION\>
+
+___
+
+### Version Control Process
+I. **Create a Feature Branch**
+Any code updates for a version change -- [Major].[Minor].[Patch] -- should be on a separate branch, referred to as a 'feature' branch.
+
+Once work on the branch is completed, a pull-request can be created to merge the branch into `dev`, a staging/pre-release branch, where those changes are tested.
+
+Once the staging branch is tested, stable code can be merged into `main` a production/release branch.
+
+________________
+##### Maintaining repos
+
+###### Branch Naming Conventions
+
+`<VERSION-RELEASE-#>/<FEATURE_NAME>/<CONTRIBUTOR>`
+
+- `<VERSION-RELEASE-#>`: Refer to [SemVer](https://semver.org/) for details
+
+- `<FEATURE_NAME>`: Descriptive title for the feature
+
+- `<CONTRIBUTOR>`: GitHub account name, e.g., https://github.com/<NAME>
+
+IV. **Documenting changes**
+
+Maintaining a CHANGELOG file is always recommended for a quick overview of how the project is progressing.
+1. Checkout main locally.
+2. From a terminal session, run the commands to use the GitHub ChangeLog Generator.
+3. Commit the CHANGELOG file to the remote branch.
+
+`changelog-generator-md`
+
+## Project documentation
+
+### Standard project docs are located in the `{PROJECT_ROOT}` folder.
+
+- README
+- LICENSE
+- CHANGELOG
+    - Refer to the Project dependencies section of the README for more information on generating a CHANGELOG file
+
+## Links
+
+* [<LINK>](<URL>): <LINK_DESC>
+* [...]
+
+## Terms of use
+
+Python Flask Dev is licensed under [MIT](https://commons.wikimedia.org/wiki/Template:X11)

python_flask_dev-0.0.1/pyproject.toml

@@ -0,0 +1,35 @@
+[project]
+name = "python-flask-dev"
+version = "0.0.1"
+authors = [
+    { name = "Dani", email = "daniasestan@gmail.com" },
+]
+description = "Package containing modules with 'helper' functions to support the development of Python Flask applications."
+readme = "README.md"
+requires-python = ">=3.12.3"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: POSIX :: Linux",
+    "Framework :: Flask",
+]
+license = "MIT"
+license-files = [
+    "LICEN[CS]E*",
+]
+dependencies = [
+    "Flask==3.1.2",
+    "numpy==2.4.2",
+    "pandas==3.0.1",
+    "build==1.4.0",
+    "twine==6.2.0",
+]
+dynamic = []
+
+[build-system]
+requires = [
+    "setuptools >= 77.0.3",
+]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.package-dir]
+"" = "src"

python_flask_dev-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

python_flask_dev-0.0.1/src/app.py

@@ -0,0 +1,246 @@
+from flask import Flask
+from python_flask_dev.formatting_data import get_filtered_key_vals
+# from data.users import get_users
+app = Flask(__name__)
+
+# sample_data = get_users()
+sample_data = [
+    {
+        "id": 1,
+        "name": "Leanne Graham",
+        "username": "Bret",
+        "email": "Sincere@april.biz",
+        "address": {
+            "street": "Kulas Light",
+            "suite": "Apt. 556",
+            "city": "Gwenborough",
+            "zipcode": "92998-3874",
+            "geo": {
+                "lat": "-37.3159",
+                "lng": "81.1496"
+            }
+        },
+        "phone": "1-770-736-8031 x56442",
+        "website": "hildegard.org",
+        "company": {
+            "name": "Romaguera-Crona",
+            "catchPhrase": "Multi-layered client-server neural-net",
+            "bs": "harness real-time e-markets"
+        }
+    },
+    {
+        "id": 2,
+        "name": "Ervin Howell",
+        "username": "Antonette",
+        "email": "Shanna@melissa.tv",
+        "address": {
+            "street": "Victor Plains",
+            "suite": "Suite 879",
+            "city": "Wisokyburgh",
+            "zipcode": "90566-7771",
+            "geo": {
+                "lat": "-43.9509",
+                "lng": "-34.4618"
+            }
+        },
+        "phone": "010-692-6593 x09125",
+        "website": "anastasia.net",
+        "company": {
+            "name": "Deckow-Crist",
+            "catchPhrase": "Proactive didactic contingency",
+            "bs": "synergize scalable supply-chains"
+        }
+    },
+    {
+        "id": 3,
+        "name": "Clementine Bauch",
+        "username": "Samantha",
+        "email": "Nathan@yesenia.net",
+        "address": {
+            "street": "Douglas Extension",
+            "suite": "Suite 847",
+            "city": "McKenziehaven",
+            "zipcode": "59590-4157",
+            "geo": {
+                "lat": "-68.6102",
+                "lng": "-47.0653"
+            }
+        },
+        "phone": "1-463-123-4447",
+        "website": "ramiro.info",
+        "company": {
+            "name": "Romaguera-Jacobson",
+            "catchPhrase": "Face to face bifurcated interface",
+            "bs": "e-enable strategic applications"
+        }
+    },
+    {
+        "id": 4,
+        "name": "Patricia Lebsack",
+        "username": "Karianne",
+        "email": "Julianne.OConner@kory.org",
+        "address": {
+            "street": "Hoeger Mall",
+            "suite": "Apt. 692",
+            "city": "South Elvis",
+            "zipcode": "53919-4257",
+            "geo": {
+                "lat": "29.4572",
+                "lng": "-164.2990"
+            }
+        },
+        "phone": "493-170-9623 x156",
+        "website": "kale.biz",
+        "company": {
+            "name": "Robel-Corkery",
+            "catchPhrase": "Multi-tiered zero tolerance productivity",
+            "bs": "transition cutting-edge web services"
+        }
+    },
+    {
+        "id": 5,
+        "name": "Chelsey Dietrich",
+        "username": "Kamren",
+        "email": "Lucio_Hettinger@annie.ca",
+        "address": {
+            "street": "Skiles Walks",
+            "suite": "Suite 351",
+            "city": "Roscoeview",
+            "zipcode": "33263",
+            "geo": {
+                "lat": "-31.8129",
+                "lng": "62.5342"
+            }
+        },
+        "phone": "(254)954-1289",
+        "website": "demarco.info",
+        "company": {
+            "name": "Keebler LLC",
+            "catchPhrase": "User-centric fault-tolerant solution",
+            "bs": "revolutionize end-to-end systems"
+        }
+    },
+    {
+        "id": 6,
+        "name": "Mrs. Dennis Schulist",
+        "username": "Leopoldo_Corkery",
+        "email": "Karley_Dach@jasper.info",
+        "address": {
+            "street": "Norberto Crossing",
+            "suite": "Apt. 950",
+            "city": "South Christy",
+            "zipcode": "23505-1337",
+            "geo": {
+                "lat": "-71.4197",
+                "lng": "71.7478"
+            }
+        },
+        "phone": "1-477-935-8478 x6430",
+        "website": "ola.org",
+        "company": {
+            "name": "Considine-Lockman",
+            "catchPhrase": "Synchronised bottom-line interface",
+            "bs": "e-enable innovative applications"
+        }
+    },
+    {
+        "id": 7,
+        "name": "Kurtis Weissnat",
+        "username": "Elwyn.Skiles",
+        "email": "Telly.Hoeger@billy.biz",
+        "address": {
+            "street": "Rex Trail",
+            "suite": "Suite 280",
+            "city": "Howemouth",
+            "zipcode": "58804-1099",
+            "geo": {
+                "lat": "24.8918",
+                "lng": "21.8984"
+            }
+        },
+        "phone": "210.067.6132",
+        "website": "elvis.io",
+        "company": {
+            "name": "Johns Group",
+            "catchPhrase": "Configurable multimedia task-force",
+            "bs": "generate enterprise e-tailers"
+        }
+    },
+    {
+        "id": 8,
+        "name": "Nicholas Runolfsdottir V",
+        "username": "Maxime_Nienow",
+        "email": "Sherwood@rosamond.me",
+        "address": {
+            "street": "Ellsworth Summit",
+            "suite": "Suite 729",
+            "city": "Aliyaview",
+            "zipcode": "45169",
+            "geo": {
+                "lat": "-14.3990",
+                "lng": "-120.7677"
+            }
+        },
+        "phone": "586.493.6943 x140",
+        "website": "jacynthe.com",
+        "company": {
+            "name": "Abernathy Group",
+            "catchPhrase": "Implemented secondary concept",
+            "bs": "e-enable extensible e-tailers"
+        }
+    },
+    {
+        "id": 9,
+        "name": "Glenna Reichert",
+        "username": "Delphine",
+        "email": "Chaim_McDermott@dana.io",
+        "address": {
+            "street": "Dayna Park",
+            "suite": "Suite 449",
+            "city": "Bartholomebury",
+            "zipcode": "76495-3109",
+            "geo": {
+                "lat": "24.6463",
+                "lng": "-168.8889"
+            }
+        },
+        "phone": "(775)976-6794 x41206",
+        "website": "conrad.com",
+        "company": {
+            "name": "Yost and Sons",
+            "catchPhrase": "Switchable contextually-based project",
+            "bs": "aggregate real-time technologies"
+        }
+    },
+    {
+        "id": 10,
+        "name": "Clementina DuBuque",
+        "username": "Moriah.Stanton",
+        "email": "Rey.Padberg@karina.biz",
+        "address": {
+            "street": "Kattie Turnpike",
+            "suite": "Suite 198",
+            "city": "Lebsackbury",
+            "zipcode": "31428-2261",
+            "geo": {
+                "lat": "-38.2386",
+                "lng": "57.2232"
+            }
+        },
+        "phone": "024-648-3804",
+        "website": "ambrose.net",
+        "company": {
+            "name": "Hoeger LLC",
+            "catchPhrase": "Centralized empowering task-force",
+            "bs": "target end-to-end models"
+        }
+    }
+]
+
+@app.route('/')
+def hello_world():  # put application's code here
+    return 'Hello World!'
+
+
+if __name__ == '__main__':
+    app.run()

python_flask_dev-0.0.1/src/python_flask_dev/custom_exceptions.py

@@ -0,0 +1,10 @@
+class CustomError(Exception):
+    """Exception raised for custom error in the application."""
+    # ATT this function doesn't accept printf for the message arg; a printf string needs to be assigned to a var
+    def __init__(self, message, error_code):
+        self.message = message
+        self.error_code = error_code
+        super().__init__(message)
+
+    def __str__(self):
+        return f"{self.message} (Error Code: {self.error_code})"