application-file-scanner 0.6.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.
- application_file_scanner-0.6.2/LICENSE.txt +7 -0
- application_file_scanner-0.6.2/MANIFEST.in +3 -0
- application_file_scanner-0.6.2/PKG-INFO +130 -0
- application_file_scanner-0.6.2/README.md +85 -0
- application_file_scanner-0.6.2/application_file_scanner/.external-package +1 -0
- application_file_scanner-0.6.2/application_file_scanner/__init__.py +12 -0
- application_file_scanner-0.6.2/application_file_scanner/application_file_scanner.py +484 -0
- application_file_scanner-0.6.2/application_file_scanner/py.typed +1 -0
- application_file_scanner-0.6.2/application_file_scanner/version.py +7 -0
- application_file_scanner-0.6.2/application_file_scanner.egg-info/PKG-INFO +130 -0
- application_file_scanner-0.6.2/application_file_scanner.egg-info/SOURCES.txt +19 -0
- application_file_scanner-0.6.2/application_file_scanner.egg-info/dependency_links.txt +1 -0
- application_file_scanner-0.6.2/application_file_scanner.egg-info/requires.txt +1 -0
- application_file_scanner-0.6.2/application_file_scanner.egg-info/top_level.txt +1 -0
- application_file_scanner-0.6.2/install-requirements.txt +2 -0
- application_file_scanner-0.6.2/pyproject.toml +3 -0
- application_file_scanner-0.6.2/setup.cfg +8 -0
- application_file_scanner-0.6.2/setup.py +114 -0
- application_file_scanner-0.6.2/test/test_application_file_scanner.py +1720 -0
- application_file_scanner-0.6.2/test/test_version.py +24 -0
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
Copyright 2019-2025 Jack De Winter
|
|
2
|
+
|
|
3
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
|
4
|
+
|
|
5
|
+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
|
6
|
+
|
|
7
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
@@ -0,0 +1,130 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: application_file_scanner
|
|
3
|
+
Version: 0.6.2
|
|
4
|
+
Summary: A small package to deal with the headaches of scanning for files for an application to execute on.
|
|
5
|
+
Home-page: https://github.com/jackdewinter/application_file_scanner
|
|
6
|
+
Author: Jack De Winter
|
|
7
|
+
Author-email: jack.de.winter@outlook.com
|
|
8
|
+
Maintainer: Jack De Winter
|
|
9
|
+
Maintainer-email: jack.de.winter@outlook.com
|
|
10
|
+
License: MIT
|
|
11
|
+
Project-URL: Documentation, https://application_file_scanner.readthedocs.io/
|
|
12
|
+
Project-URL: Change Log, https://application_file_scanner.readthedocs.io/en/latest/changelog/
|
|
13
|
+
Keywords: properties
|
|
14
|
+
Classifier: Development Status :: 4 - Beta
|
|
15
|
+
Classifier: Environment :: Console
|
|
16
|
+
Classifier: Intended Audience :: Developers
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
21
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
22
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
23
|
+
Classifier: Operating System :: OS Independent
|
|
24
|
+
Classifier: Natural Language :: English
|
|
25
|
+
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
|
|
26
|
+
Requires-Python: >=3.10.0
|
|
27
|
+
Description-Content-Type: text/markdown
|
|
28
|
+
License-File: LICENSE.txt
|
|
29
|
+
Requires-Dist: typing-extensions>=4.5.0
|
|
30
|
+
Dynamic: author
|
|
31
|
+
Dynamic: author-email
|
|
32
|
+
Dynamic: classifier
|
|
33
|
+
Dynamic: description
|
|
34
|
+
Dynamic: description-content-type
|
|
35
|
+
Dynamic: home-page
|
|
36
|
+
Dynamic: keywords
|
|
37
|
+
Dynamic: license
|
|
38
|
+
Dynamic: license-file
|
|
39
|
+
Dynamic: maintainer
|
|
40
|
+
Dynamic: maintainer-email
|
|
41
|
+
Dynamic: project-url
|
|
42
|
+
Dynamic: requires-dist
|
|
43
|
+
Dynamic: requires-python
|
|
44
|
+
Dynamic: summary
|
|
45
|
+
|
|
46
|
+
# Library Package: application_file_scanner
|
|
47
|
+
|
|
48
|
+
| | |
|
|
49
|
+
|---|---|
|
|
50
|
+
|Project|[](https://pypi.org/project/application_file_scanner) [](https://pypi.org/project/application_file_scanner)  [](https://github.com/jackdewinter/application_file_scanner/blob/main/LICENSE.txt) [](https://github.com/jackdewinter/application_file_scanner)|
|
|
51
|
+
|Quality|[](https://github.com/jackdewinter/application_file_scanner/actions/workflows/main.yml) [](https://github.com/jackdewinter/application_file_scanner/issues) [](https://codecov.io/gh/jackdewinter/application_file_scanner) [](https://sourcery.ai)  |
|
|
52
|
+
| |     |
|
|
53
|
+
|Community|[](https://github.com/jackdewinter/application_file_scanner/graphs/commit-activity) [](https://github.com/jackdewinter/application_file_scanner/stargazers) [](https://github.com/jackdewinter/application_file_scanner/network/members) [](https://github.com/jackdewinter/application_file_scanner/graphs/contributors) [](https://pypistats.org/packages/application_file_scanner)|
|
|
54
|
+
|Maintainers|[](https://www.linkedin.com/in/jackdewinter/)|
|
|
55
|
+
|
|
56
|
+
The `application_file_scanner` package was born out of necessity.
|
|
57
|
+
During the creation of the [PyMarkdown](https://github.com/jackdewinter/pymarkdown) project,
|
|
58
|
+
there was a clear need for a robust manner of specifying which files the PyMarkdown
|
|
59
|
+
project needed to scan. After fiddling with it over the course of many months,
|
|
60
|
+
it just made sense to move all that hard work into its own project.
|
|
61
|
+
|
|
62
|
+
The `application_file_scanner` library has the following advnatages:
|
|
63
|
+
|
|
64
|
+
- Thoroughly tested
|
|
65
|
+
- The project currently has over XX tests and coverage percentages over XX%.
|
|
66
|
+
- Simple... With Examples
|
|
67
|
+
- The package was created with the intention of being as easy to use as possbile.
|
|
68
|
+
- To that extent, there are X basic usage examples and over XX advanced usage examples.
|
|
69
|
+
|
|
70
|
+
## Requirements
|
|
71
|
+
|
|
72
|
+
This project required Python 3.8 or later to function.
|
|
73
|
+
|
|
74
|
+
## Installation
|
|
75
|
+
|
|
76
|
+
```sh
|
|
77
|
+
pip install application_file_scanner
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
## How To Use This Package
|
|
81
|
+
|
|
82
|
+
The primary goal of this package is to provide a thoroughly tested package that
|
|
83
|
+
handles the hard work of specifying the files that a given application will process.
|
|
84
|
+
|
|
85
|
+
### Examples
|
|
86
|
+
|
|
87
|
+
For concrete examples that show the power of this library package, please consult
|
|
88
|
+
the [Examples Document](./docs/examples.md). If you come up with a normal example
|
|
89
|
+
of how to use our package that we have missed, or come up with a novel example of
|
|
90
|
+
how to use our package, please file an issue using the process below and let us
|
|
91
|
+
know. From our experience, one example can often paint a picture of how to use our
|
|
92
|
+
project that is difficult to explain clearly with just words.
|
|
93
|
+
|
|
94
|
+
## Issues and Future Plans
|
|
95
|
+
|
|
96
|
+
If you would like to report an issue with the library or the documentation, please
|
|
97
|
+
file an issue [using GitHub](https://github.com/jackdewinter/application_file_scanner/issues).
|
|
98
|
+
Please remember to fill in as much information as possible including a good, repeatable
|
|
99
|
+
pattern for reproducing the issue. Do not overflow us with too much information,
|
|
100
|
+
but provide us with enough information to make the problem evident to us.
|
|
101
|
+
|
|
102
|
+
If you would like to us to implement a feature that you believe is important, please
|
|
103
|
+
file an issue [using GitHub](https://github.com/jackdewinter/application_file_scanner/issues)
|
|
104
|
+
that includes what you want to add, why you want to add it, and why it is important
|
|
105
|
+
to you, and how you think it will help others. We truly want to listen to what
|
|
106
|
+
you see as a good feature, so please do not be upset if we say "no" or "let me
|
|
107
|
+
think about it".
|
|
108
|
+
|
|
109
|
+
Please note that the issue you file will usually be the start of a conversation,
|
|
110
|
+
so be ready for more questions. If you have any Python developer skills, please
|
|
111
|
+
mention that as well. The conversations about "hey, can you..." is a lot different
|
|
112
|
+
than "if I do... can I add it to the project?".
|
|
113
|
+
|
|
114
|
+
## When Did Things Change?
|
|
115
|
+
|
|
116
|
+
The changelog for this project is maintained [at this location](/changelog.md).
|
|
117
|
+
|
|
118
|
+
## Still Have Questions?
|
|
119
|
+
|
|
120
|
+
If you still have questions, please consult our
|
|
121
|
+
[Frequently Asked Questions](/docs/faq.md) document.
|
|
122
|
+
|
|
123
|
+
## Instructions For Contributing
|
|
124
|
+
|
|
125
|
+
Developer notes on various topics are kept in the the
|
|
126
|
+
[Developer Notes](/docs/developer.md) document.
|
|
127
|
+
|
|
128
|
+
If you attempting to contribute something to this project,
|
|
129
|
+
please follow the steps outlined in the
|
|
130
|
+
[CONTRIBUTING.md](/CONTRIBUTING.md) file.
|
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
# Library Package: application_file_scanner
|
|
2
|
+
|
|
3
|
+
| | |
|
|
4
|
+
|---|---|
|
|
5
|
+
|Project|[](https://pypi.org/project/application_file_scanner) [](https://pypi.org/project/application_file_scanner)  [](https://github.com/jackdewinter/application_file_scanner/blob/main/LICENSE.txt) [](https://github.com/jackdewinter/application_file_scanner)|
|
|
6
|
+
|Quality|[](https://github.com/jackdewinter/application_file_scanner/actions/workflows/main.yml) [](https://github.com/jackdewinter/application_file_scanner/issues) [](https://codecov.io/gh/jackdewinter/application_file_scanner) [](https://sourcery.ai)  |
|
|
7
|
+
| |     |
|
|
8
|
+
|Community|[](https://github.com/jackdewinter/application_file_scanner/graphs/commit-activity) [](https://github.com/jackdewinter/application_file_scanner/stargazers) [](https://github.com/jackdewinter/application_file_scanner/network/members) [](https://github.com/jackdewinter/application_file_scanner/graphs/contributors) [](https://pypistats.org/packages/application_file_scanner)|
|
|
9
|
+
|Maintainers|[](https://www.linkedin.com/in/jackdewinter/)|
|
|
10
|
+
|
|
11
|
+
The `application_file_scanner` package was born out of necessity.
|
|
12
|
+
During the creation of the [PyMarkdown](https://github.com/jackdewinter/pymarkdown) project,
|
|
13
|
+
there was a clear need for a robust manner of specifying which files the PyMarkdown
|
|
14
|
+
project needed to scan. After fiddling with it over the course of many months,
|
|
15
|
+
it just made sense to move all that hard work into its own project.
|
|
16
|
+
|
|
17
|
+
The `application_file_scanner` library has the following advnatages:
|
|
18
|
+
|
|
19
|
+
- Thoroughly tested
|
|
20
|
+
- The project currently has over XX tests and coverage percentages over XX%.
|
|
21
|
+
- Simple... With Examples
|
|
22
|
+
- The package was created with the intention of being as easy to use as possbile.
|
|
23
|
+
- To that extent, there are X basic usage examples and over XX advanced usage examples.
|
|
24
|
+
|
|
25
|
+
## Requirements
|
|
26
|
+
|
|
27
|
+
This project required Python 3.8 or later to function.
|
|
28
|
+
|
|
29
|
+
## Installation
|
|
30
|
+
|
|
31
|
+
```sh
|
|
32
|
+
pip install application_file_scanner
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## How To Use This Package
|
|
36
|
+
|
|
37
|
+
The primary goal of this package is to provide a thoroughly tested package that
|
|
38
|
+
handles the hard work of specifying the files that a given application will process.
|
|
39
|
+
|
|
40
|
+
### Examples
|
|
41
|
+
|
|
42
|
+
For concrete examples that show the power of this library package, please consult
|
|
43
|
+
the [Examples Document](./docs/examples.md). If you come up with a normal example
|
|
44
|
+
of how to use our package that we have missed, or come up with a novel example of
|
|
45
|
+
how to use our package, please file an issue using the process below and let us
|
|
46
|
+
know. From our experience, one example can often paint a picture of how to use our
|
|
47
|
+
project that is difficult to explain clearly with just words.
|
|
48
|
+
|
|
49
|
+
## Issues and Future Plans
|
|
50
|
+
|
|
51
|
+
If you would like to report an issue with the library or the documentation, please
|
|
52
|
+
file an issue [using GitHub](https://github.com/jackdewinter/application_file_scanner/issues).
|
|
53
|
+
Please remember to fill in as much information as possible including a good, repeatable
|
|
54
|
+
pattern for reproducing the issue. Do not overflow us with too much information,
|
|
55
|
+
but provide us with enough information to make the problem evident to us.
|
|
56
|
+
|
|
57
|
+
If you would like to us to implement a feature that you believe is important, please
|
|
58
|
+
file an issue [using GitHub](https://github.com/jackdewinter/application_file_scanner/issues)
|
|
59
|
+
that includes what you want to add, why you want to add it, and why it is important
|
|
60
|
+
to you, and how you think it will help others. We truly want to listen to what
|
|
61
|
+
you see as a good feature, so please do not be upset if we say "no" or "let me
|
|
62
|
+
think about it".
|
|
63
|
+
|
|
64
|
+
Please note that the issue you file will usually be the start of a conversation,
|
|
65
|
+
so be ready for more questions. If you have any Python developer skills, please
|
|
66
|
+
mention that as well. The conversations about "hey, can you..." is a lot different
|
|
67
|
+
than "if I do... can I add it to the project?".
|
|
68
|
+
|
|
69
|
+
## When Did Things Change?
|
|
70
|
+
|
|
71
|
+
The changelog for this project is maintained [at this location](/changelog.md).
|
|
72
|
+
|
|
73
|
+
## Still Have Questions?
|
|
74
|
+
|
|
75
|
+
If you still have questions, please consult our
|
|
76
|
+
[Frequently Asked Questions](/docs/faq.md) document.
|
|
77
|
+
|
|
78
|
+
## Instructions For Contributing
|
|
79
|
+
|
|
80
|
+
Developer notes on various topics are kept in the the
|
|
81
|
+
[Developer Notes](/docs/developer.md) document.
|
|
82
|
+
|
|
83
|
+
If you attempting to contribute something to this project,
|
|
84
|
+
please follow the steps outlined in the
|
|
85
|
+
[CONTRIBUTING.md](/CONTRIBUTING.md) file.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
Marker File
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
"""
|
|
2
|
+
Module to provide for imports fromt he application_file_scanner class.
|
|
3
|
+
|
|
4
|
+
https://stackoverflow.com/questions/44834/what-does-all-mean-in-python#When%20Avoiding%20__all__%20Makes%20Sense
|
|
5
|
+
"""
|
|
6
|
+
|
|
7
|
+
from .application_file_scanner import ApplicationFileScannerOutputProtocol, ApplicationFileScanner # noqa F401
|
|
8
|
+
|
|
9
|
+
__all__ = [
|
|
10
|
+
"ApplicationFileScanner",
|
|
11
|
+
"ApplicationFileScannerOutputProtocol",
|
|
12
|
+
]
|