Flask-Imp 5.2.0__tar.gz → 5.2.2__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.
Files changed (130) hide show
  1. {flask_imp-5.2.0 → flask_imp-5.2.2}/PKG-INFO +1 -95
  2. flask_imp-5.2.2/README.md +65 -0
  3. {flask_imp-5.2.0 → flask_imp-5.2.2}/pyproject.toml +2 -3
  4. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/_cli/__init__.py +2 -7
  5. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/conftest.py +0 -1
  6. flask_imp-5.2.0/README.md +0 -159
  7. {flask_imp-5.2.0 → flask_imp-5.2.2}/LICENSE +0 -0
  8. {flask_imp-5.2.0 → flask_imp-5.2.2}/requirements/build.in +0 -0
  9. {flask_imp-5.2.0 → flask_imp-5.2.2}/requirements/build.txt +0 -0
  10. {flask_imp-5.2.0 → flask_imp-5.2.2}/requirements/dev.in +0 -0
  11. {flask_imp-5.2.0 → flask_imp-5.2.2}/requirements/dev.txt +0 -0
  12. {flask_imp-5.2.0 → flask_imp-5.2.2}/requirements/docs.in +0 -0
  13. {flask_imp-5.2.0 → flask_imp-5.2.2}/requirements/docs.txt +0 -0
  14. {flask_imp-5.2.0 → flask_imp-5.2.2}/requirements/tests.in +0 -0
  15. {flask_imp-5.2.0 → flask_imp-5.2.2}/requirements/tests.txt +0 -0
  16. {flask_imp-5.2.0 → flask_imp-5.2.2}/requirements/typing.in +0 -0
  17. {flask_imp-5.2.0 → flask_imp-5.2.2}/requirements/typing.txt +0 -0
  18. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/__init__.py +0 -0
  19. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/_cli/blueprint.py +0 -0
  20. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/_cli/filelib/__init__.py +0 -0
  21. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/_cli/filelib/api_blueprint.py +0 -0
  22. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/_cli/filelib/blueprint.py +0 -0
  23. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/_cli/filelib/extensions.py +0 -0
  24. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/_cli/filelib/favicon.py +0 -0
  25. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/_cli/filelib/flask_imp_logo.py +0 -0
  26. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/_cli/filelib/head_tag_generator.py +0 -0
  27. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/_cli/filelib/init.py +0 -0
  28. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/_cli/filelib/main_js.py +0 -0
  29. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/_cli/filelib/models.py +0 -0
  30. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/_cli/filelib/resources.py +0 -0
  31. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/_cli/filelib/templates.py +0 -0
  32. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/_cli/filelib/water_css.py +0 -0
  33. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/_cli/helpers.py +0 -0
  34. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/_cli/init.py +0 -0
  35. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/auth/__init__.py +0 -0
  36. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/auth/__legacy__.py +0 -0
  37. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/auth/__private_funcs__.py +0 -0
  38. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/auth/authenticate_password.py +0 -0
  39. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/auth/dataclasses.py +0 -0
  40. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/auth/encrypt_password.py +0 -0
  41. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/auth/generate_alphanumeric_validator.py +0 -0
  42. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/auth/generate_csrf_token.py +0 -0
  43. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/auth/generate_email_validator.py +0 -0
  44. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/auth/generate_numeric_validator.py +0 -0
  45. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/auth/generate_password.py +0 -0
  46. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/auth/generate_private_key.py +0 -0
  47. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/auth/generate_salt.py +0 -0
  48. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/auth/is_email_address_valid.py +0 -0
  49. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/auth/is_username_valid.py +0 -0
  50. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/config/__init__.py +0 -0
  51. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/config/database_config.py +0 -0
  52. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/config/flask_config.py +0 -0
  53. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/config/imp_blueprint_config.py +0 -0
  54. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/config/imp_config.py +0 -0
  55. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/exceptions.py +0 -0
  56. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/imp.py +0 -0
  57. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/imp_blueprint.py +0 -0
  58. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/protocols.py +0 -0
  59. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/registeries.py +0 -0
  60. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/security/__init__.py +0 -0
  61. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/security/__private_funcs__.py +0 -0
  62. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/security/api_login_check.py +0 -0
  63. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/security/include_csrf.py +0 -0
  64. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/security/login_check.py +0 -0
  65. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/security/pass_function_check.py +0 -0
  66. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/security/permission_check.py +0 -0
  67. {flask_imp-5.2.0 → flask_imp-5.2.2}/src/flask_imp/utilities.py +0 -0
  68. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/__init__.py +0 -0
  69. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/blueprints/from_object/__init__.py +0 -0
  70. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/blueprints/from_object/routes/index.py +0 -0
  71. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/blueprints/from_object/templates/from_object/index.html +0 -0
  72. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/blueprints/regular_blueprint/__init__.py +0 -0
  73. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/blueprints/tests/__init__.py +0 -0
  74. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/blueprints/tests/group_of_nested/nested_test_one/__init__.py +0 -0
  75. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/blueprints/tests/group_of_nested/nested_test_one/routes/index.py +0 -0
  76. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/blueprints/tests/group_of_nested/nested_test_one/templates/nested_test_one/index.html +0 -0
  77. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/blueprints/tests/group_of_nested/nested_test_two/__init__.py +0 -0
  78. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/blueprints/tests/group_of_nested/nested_test_two/routes/index.py +0 -0
  79. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/blueprints/tests/group_of_nested/nested_test_two/templates/nested_test_two/index.html +0 -0
  80. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/blueprints/tests/models/tests_model.py +0 -0
  81. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/blueprints/tests/nested_test/__init__.py +0 -0
  82. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/blueprints/tests/nested_test/models/nested_test_model.py +0 -0
  83. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/blueprints/tests/nested_test/routes/index.py +0 -0
  84. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/blueprints/tests/nested_test/templates/nested_test/index.html +0 -0
  85. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/blueprints/tests/routes/auth.py +0 -0
  86. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/blueprints/tests/routes/context_processors.py +0 -0
  87. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/blueprints/tests/routes/csrf.py +0 -0
  88. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/blueprints/tests/routes/database.py +0 -0
  89. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/blueprints/tests/routes/error_page.py +0 -0
  90. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/blueprints/tests/routes/filters.py +0 -0
  91. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/blueprints/tests/routes/index.py +0 -0
  92. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/blueprints/tests/routes/security.py +0 -0
  93. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/blueprints/tests/routes/static.py +0 -0
  94. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/blueprints/tests/templates/tests/already_logged_in.html +0 -0
  95. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/blueprints/tests/templates/tests/context_processors.html +0 -0
  96. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/blueprints/tests/templates/tests/database.html +0 -0
  97. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/blueprints/tests/templates/tests/filters.html +0 -0
  98. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/blueprints/tests/templates/tests/get-to-post.html +0 -0
  99. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/blueprints/tests/templates/tests/index.html +0 -0
  100. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/blueprints/tests/templates/tests/login_failed.html +0 -0
  101. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/blueprints/tests/templates/tests/security.html +0 -0
  102. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/blueprints/tests/templates/tests/static.html +0 -0
  103. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/extensions/__init__.py +0 -0
  104. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/models/example_table.py +0 -0
  105. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/models/example_user.py +0 -0
  106. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/models/example_user_bind.py +0 -0
  107. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/nested_test_database.sqlite +0 -0
  108. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/resources/cli/cli.py +0 -0
  109. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/resources/context_processors/context_processors.py +0 -0
  110. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/resources/error_handlers/error_handlers.py +0 -0
  111. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/resources/filters/filters.py +0 -0
  112. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/resources/root_routes.py +0 -0
  113. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/resources/routes/routes.py +0 -0
  114. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/resources/static/css/main.css +0 -0
  115. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/resources/static/img/Flask-Imp-Small.png +0 -0
  116. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/resources/static/js/main.js +0 -0
  117. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/resources/templates/errors/400.html +0 -0
  118. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/resources/templates/errors/401.html +0 -0
  119. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/resources/templates/errors/403.html +0 -0
  120. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/resources/templates/errors/404.html +0 -0
  121. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/resources/templates/errors/405.html +0 -0
  122. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/resources/templates/errors/500.html +0 -0
  123. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/resources/templates/extends/main.html +0 -0
  124. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/resources/templates/includes/footer.html +0 -0
  125. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/resources/templates/includes/menu.html +0 -0
  126. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/resources/templates/index.html +0 -0
  127. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/root_blueprint/__init__.py +0 -0
  128. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/root_blueprint/routes/index.py +0 -0
  129. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_app/tests_blueprint.sqlite +0 -0
  130. {flask_imp-5.2.0 → flask_imp-5.2.2}/tests/test_group.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: flask-imp
3
- Version: 5.2.0
3
+ Version: 5.2.2
4
4
  Summary: A Flask auto importer that allows your Flask apps to grow big.
5
5
  Author-email: David Carmichael <david@uilix.com>
6
6
  Requires-Python: >=3.9
@@ -91,97 +91,3 @@ pip install flask-imp
91
91
  flask-imp init
92
92
  ```
93
93
 
94
- ---
95
-
96
- ## Working on this project.
97
-
98
- ### Setup.
99
-
100
- **Create a new project folder and navigate to it in the terminal, then clone this repository.**
101
-
102
- ```bash
103
- git clone https://github.com/CheeseCake87/flask-imp.git
104
- ```
105
-
106
- ### Create a virtual environment and activate it.
107
-
108
- **Linux / MacOS**
109
-
110
- ```bash
111
- python3 -m venv venv
112
- ```
113
-
114
- ```bash
115
- source venv/bin/activate
116
- ```
117
-
118
- **Windows**
119
-
120
- ```bash
121
- python -m venv venv
122
- ```
123
-
124
- ```bash
125
- .\venv\Scripts\activate
126
- ```
127
-
128
- ### Install the requirements.
129
-
130
- ```bash
131
- pip install -r requirements/dev.txt
132
- ```
133
-
134
- ### Install the local version of Flask-Imp.
135
-
136
- ```bash
137
- flit install
138
- ```
139
-
140
- ### Create a new app.
141
-
142
- ```bash
143
- flask-imp init --name app --full
144
- ```
145
-
146
- ### Run the included Flask app.
147
-
148
- ```bash
149
- Flask run --debug
150
- ```
151
-
152
- ### Run the tests.
153
-
154
- ```bash
155
- pytest
156
- ```
157
-
158
- ### Run the tests under multiple Python versions using docker.
159
-
160
- ```bash
161
- python3 tests_docker
162
- ```
163
-
164
- ### Info
165
-
166
- The tests are located in the `tests` folder.
167
-
168
- The test Flask app is located in the `tests/test_app` folder.
169
-
170
- The tests are linked to the `tests` blueprint located at `tests/test_app/blueprints/tests`.
171
-
172
- ### Building the docs.
173
-
174
- All docs are generated from the [docs](docs) folder.
175
-
176
- Edit these files, then run the following command to generate the docs.
177
-
178
- ```bash
179
- flask --app docs compile
180
- ```
181
-
182
- You can set it to watch for changes and automatically recompile the docs by adding the `--watch` flag.
183
-
184
- ```bash
185
- flask --app gdocs compile --watch
186
- ```
187
-
@@ -0,0 +1,65 @@
1
+ ![](https://raw.githubusercontent.com/CheeseCake87/Flask-Imp/master/_assets/Flask-Imp-Small.png)
2
+ # Flask-Imp
3
+
4
+ ![tests](https://github.com/CheeseCake87/flask-imp/actions/workflows/tests.yml/badge.svg)
5
+ [![PyPI version](https://img.shields.io/pypi/v/flask-imp)](https://pypi.org/project/flask-imp/)
6
+ [![License](https://img.shields.io/github/license/CheeseCake87/flask-imp)](https://raw.githubusercontent.com/CheeseCake87/flask-imp/master/LICENSE)
7
+ ![Downloads](https://static.pepy.tech/badge/flask-imp)
8
+ ![black](https://img.shields.io/badge/code%20style-black-000000.svg)
9
+
10
+ ## What is Flask-Imp?
11
+
12
+ Flask-Imp's main purpose is to help simplify the importing of blueprints, resources, and models.
13
+ It has a few extra features built in to help with securing pages and password authentication.
14
+
15
+ ## Documentation
16
+
17
+ [https://cheesecake87.github.io/flask-imp/](https://cheesecake87.github.io/flask-imp/)
18
+
19
+ ## Getting Started
20
+
21
+ ### Setup.
22
+
23
+ Create a new project folder and navigate to it.
24
+
25
+ ```text
26
+ # Linux
27
+ cd /path/to/project-folder
28
+
29
+ # Windows
30
+ cd C:\path\to\project-folder
31
+ ```
32
+
33
+ ### Create a virtual environment and activate it.
34
+
35
+ **Linux / MacOS**
36
+
37
+ ```bash
38
+ python3 -m venv venv
39
+ ```
40
+
41
+ ```bash
42
+ source venv/bin/activate
43
+ ```
44
+
45
+ **Windows**
46
+
47
+ ```bash
48
+ python -m venv venv
49
+ ```
50
+
51
+ ```bash
52
+ .\venv\Scripts\activate
53
+ ```
54
+
55
+ ### Install Flask-Imp
56
+
57
+ ```bash
58
+ pip install flask-imp
59
+ ```
60
+
61
+ ### Create a new project.
62
+
63
+ ```bash
64
+ flask-imp init
65
+ ```
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "flask-imp"
3
- version = "5.2.0"
3
+ version = "5.2.2"
4
4
  description = 'A Flask auto importer that allows your Flask apps to grow big.'
5
5
  authors = [{ name = "David Carmichael", email = "david@uilix.com" }]
6
6
  readme = "README.md"
@@ -39,8 +39,6 @@ build-backend = "flit_core.buildapi"
39
39
 
40
40
  [tool.pyqwe]
41
41
  install = "*:flit install --symlink"
42
- build = "*:flit build"
43
- publish = "*shell:export=FLIT_USERNAME=__token__ && flit publish"
44
42
  docs = "*:flask --app docs compile"
45
43
  docs-watch = "*:flask --app gdocs compile --watch"
46
44
 
@@ -55,6 +53,7 @@ exclude = [
55
53
  "tests_docker",
56
54
  ".gitignore",
57
55
  ".env",
56
+ "CONTRIBUTING.md",
58
57
  ]
59
58
 
60
59
  [tool.mypy]
@@ -25,16 +25,13 @@ def cli() -> None:
25
25
  "--folder",
26
26
  nargs=1,
27
27
  default=".",
28
- prompt=(
29
- f"Folder {Sp.WARNING}(relative to CWD){Sp.END}"
30
- ),
28
+ prompt=(f"Folder {Sp.WARNING}(relative to CWD){Sp.END}"),
31
29
  help="The folder to create the blueprint in, creation is relative to the current working directory.",
32
30
  )
33
31
  def add_blueprint(name: str, folder: str) -> None:
34
32
  _add_blueprint(name=name, folder=folder)
35
33
 
36
34
 
37
-
38
35
  @cli.command("api-blueprint", help="Create a flask-imp api blueprint")
39
36
  @click.option(
40
37
  "-n",
@@ -49,9 +46,7 @@ def add_blueprint(name: str, folder: str) -> None:
49
46
  "--folder",
50
47
  nargs=1,
51
48
  default=".",
52
- prompt=(
53
- f"Folder {Sp.WARNING}(relative to CWD){Sp.END}"
54
- ),
49
+ prompt=(f"Folder {Sp.WARNING}(relative to CWD){Sp.END}"),
55
50
  help="The folder to create the api blueprint in, creation is relative to the current working directory.",
56
51
  )
57
52
  def add_api_blueprint(name: str, folder: str) -> None:
@@ -1,4 +1,3 @@
1
- import os
2
1
  from pathlib import Path
3
2
 
4
3
  import pytest
flask_imp-5.2.0/README.md DELETED
@@ -1,159 +0,0 @@
1
- ![](https://raw.githubusercontent.com/CheeseCake87/Flask-Imp/master/_assets/Flask-Imp-Small.png)
2
- # Flask-Imp
3
-
4
- ![tests](https://github.com/CheeseCake87/flask-imp/actions/workflows/tests.yml/badge.svg)
5
- [![PyPI version](https://img.shields.io/pypi/v/flask-imp)](https://pypi.org/project/flask-imp/)
6
- [![License](https://img.shields.io/github/license/CheeseCake87/flask-imp)](https://raw.githubusercontent.com/CheeseCake87/flask-imp/master/LICENSE)
7
- ![Downloads](https://static.pepy.tech/badge/flask-imp)
8
- ![black](https://img.shields.io/badge/code%20style-black-000000.svg)
9
-
10
- ## What is Flask-Imp?
11
-
12
- Flask-Imp's main purpose is to help simplify the importing of blueprints, resources, and models.
13
- It has a few extra features built in to help with securing pages and password authentication.
14
-
15
- ## Documentation
16
-
17
- [https://cheesecake87.github.io/flask-imp/](https://cheesecake87.github.io/flask-imp/)
18
-
19
- ## Getting Started
20
-
21
- ### Setup.
22
-
23
- Create a new project folder and navigate to it.
24
-
25
- ```text
26
- # Linux
27
- cd /path/to/project-folder
28
-
29
- # Windows
30
- cd C:\path\to\project-folder
31
- ```
32
-
33
- ### Create a virtual environment and activate it.
34
-
35
- **Linux / MacOS**
36
-
37
- ```bash
38
- python3 -m venv venv
39
- ```
40
-
41
- ```bash
42
- source venv/bin/activate
43
- ```
44
-
45
- **Windows**
46
-
47
- ```bash
48
- python -m venv venv
49
- ```
50
-
51
- ```bash
52
- .\venv\Scripts\activate
53
- ```
54
-
55
- ### Install Flask-Imp
56
-
57
- ```bash
58
- pip install flask-imp
59
- ```
60
-
61
- ### Create a new project.
62
-
63
- ```bash
64
- flask-imp init
65
- ```
66
-
67
- ---
68
-
69
- ## Working on this project.
70
-
71
- ### Setup.
72
-
73
- **Create a new project folder and navigate to it in the terminal, then clone this repository.**
74
-
75
- ```bash
76
- git clone https://github.com/CheeseCake87/flask-imp.git
77
- ```
78
-
79
- ### Create a virtual environment and activate it.
80
-
81
- **Linux / MacOS**
82
-
83
- ```bash
84
- python3 -m venv venv
85
- ```
86
-
87
- ```bash
88
- source venv/bin/activate
89
- ```
90
-
91
- **Windows**
92
-
93
- ```bash
94
- python -m venv venv
95
- ```
96
-
97
- ```bash
98
- .\venv\Scripts\activate
99
- ```
100
-
101
- ### Install the requirements.
102
-
103
- ```bash
104
- pip install -r requirements/dev.txt
105
- ```
106
-
107
- ### Install the local version of Flask-Imp.
108
-
109
- ```bash
110
- flit install
111
- ```
112
-
113
- ### Create a new app.
114
-
115
- ```bash
116
- flask-imp init --name app --full
117
- ```
118
-
119
- ### Run the included Flask app.
120
-
121
- ```bash
122
- Flask run --debug
123
- ```
124
-
125
- ### Run the tests.
126
-
127
- ```bash
128
- pytest
129
- ```
130
-
131
- ### Run the tests under multiple Python versions using docker.
132
-
133
- ```bash
134
- python3 tests_docker
135
- ```
136
-
137
- ### Info
138
-
139
- The tests are located in the `tests` folder.
140
-
141
- The test Flask app is located in the `tests/test_app` folder.
142
-
143
- The tests are linked to the `tests` blueprint located at `tests/test_app/blueprints/tests`.
144
-
145
- ### Building the docs.
146
-
147
- All docs are generated from the [docs](docs) folder.
148
-
149
- Edit these files, then run the following command to generate the docs.
150
-
151
- ```bash
152
- flask --app docs compile
153
- ```
154
-
155
- You can set it to watch for changes and automatically recompile the docs by adding the `--watch` flag.
156
-
157
- ```bash
158
- flask --app gdocs compile --watch
159
- ```
File without changes
File without changes
File without changes