detquantlib 3.0.0__tar.gz → 3.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.
Files changed (14) hide show
  1. {detquantlib-3.0.0 → detquantlib-3.0.1}/PKG-INFO +39 -3
  2. {detquantlib-3.0.0 → detquantlib-3.0.1}/README.md +38 -2
  3. detquantlib-3.0.1/detquantlib/data/__init__.py +5 -0
  4. {detquantlib-3.0.0 → detquantlib-3.0.1}/pyproject.toml +1 -1
  5. {detquantlib-3.0.0 → detquantlib-3.0.1}/LICENSE.txt +0 -0
  6. {detquantlib-3.0.0 → detquantlib-3.0.1}/detquantlib/__init__.py +0 -0
  7. {detquantlib-3.0.0 → detquantlib-3.0.1}/detquantlib/data/databases/detdatabase.py +0 -0
  8. {detquantlib-3.0.0 → detquantlib-3.0.1}/detquantlib/data/entsoe/entsoe.py +0 -0
  9. {detquantlib-3.0.0 → detquantlib-3.0.1}/detquantlib/data/sftp/sftp.py +0 -0
  10. {detquantlib-3.0.0 → detquantlib-3.0.1}/detquantlib/dates/dates.py +0 -0
  11. {detquantlib-3.0.0 → detquantlib-3.0.1}/detquantlib/figures/plotly_figures.py +0 -0
  12. {detquantlib-3.0.0 → detquantlib-3.0.1}/detquantlib/stats/data_analysis.py +0 -0
  13. {detquantlib-3.0.0 → detquantlib-3.0.1}/detquantlib/tradable_products/tradable_products.py +0 -0
  14. {detquantlib-3.0.0 → detquantlib-3.0.1}/detquantlib/utils/utils.py +0 -0
{detquantlib-3.0.0 → detquantlib-3.0.1}/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.3
2
2
  Name: detquantlib
3
- Version: 3.0.0
3
+ Version: 3.0.1
4
4
  Summary: An internal library containing functions and classes that can be used across Quant models.
5
5
  Author: DET
6
6
  Requires-Python: >=3.10,<4.0
@@ -25,7 +25,9 @@ Description-Content-Type: text/markdown
25
25
 
26
26
  - [DET Quant Library](#det-quant-library)
27
27
  - [Table of contents](#table-of-contents)
28
- - [General overview](#general-overview)
28
+ - [Overview](#overview)
29
+ - [Exposed symbols](#exposed-symbols)
30
+ - [List of exposed symbols](#list-of-exposed-symbols)
29
31
  - [Configuration](#configuration)
30
32
  - [Dependencies](#dependencies)
31
33
  - [Dependency manager](#dependency-manager)
@@ -43,11 +45,45 @@ Description-Content-Type: text/markdown
43
45
 
44
46
  <!--TOC-->
45
47
 
46
- ## General overview
48
+ ## Overview
47
49
 
48
50
  The DET Quant Library is an internal library containing functions and classes that can be used
49
51
  across Quant models.
50
52
 
53
+ ## Exposed symbols
54
+
55
+ Some of the package's symbols (i.e. functions, classes, modules, etc.) are exposed via
56
+ `__init__.py` files. They can therefore be imported with a more concise notation that does not
57
+ require specifying their full path.
58
+
59
+ This section references all exposed symbols, and for each one of them, provides an exhaustive
60
+ list of the ways they can be imported.
61
+
62
+ Note: The list below is auto-generated and can be udpated with the following command in the
63
+ terminal:
64
+
65
+ ```cmd
66
+ poetry run python docs.py
67
+ ```
68
+
69
+ ### List of exposed symbols
70
+
71
+ <!-- START EXPOSED SYMBOLS AUTO-GENERATED -->
72
+
73
+ Classes:
74
+
75
+ - `DetDatabase`:
76
+ - `from detquantlib.data import DetDatabase`
77
+ - `from detquantlib.data.databases.detdatabase import DetDatabase`
78
+ - `Entsoe`:
79
+ - `from detquantlib.data import Entsoe`
80
+ - `from detquantlib.data.entsoe.entsoe import Entsoe`
81
+ - `Sftp`:
82
+ - `from detquantlib.data import Sftp`
83
+ - `from detquantlib.data.sftp.sftp import Sftp`
84
+
85
+ <!-- END EXPOSED SYMBOLS AUTO-GENERATED -->
86
+
51
87
  ## Configuration
52
88
 
53
89
  ### Dependencies
{detquantlib-3.0.0 → detquantlib-3.0.1}/README.md RENAMED
@@ -6,7 +6,9 @@
6
6
 
7
7
  - [DET Quant Library](#det-quant-library)
8
8
  - [Table of contents](#table-of-contents)
9
- - [General overview](#general-overview)
9
+ - [Overview](#overview)
10
+ - [Exposed symbols](#exposed-symbols)
11
+ - [List of exposed symbols](#list-of-exposed-symbols)
10
12
  - [Configuration](#configuration)
11
13
  - [Dependencies](#dependencies)
12
14
  - [Dependency manager](#dependency-manager)
@@ -24,11 +26,45 @@
24
26
 
25
27
  <!--TOC-->
26
28
 
27
- ## General overview
29
+ ## Overview
28
30
 
29
31
  The DET Quant Library is an internal library containing functions and classes that can be used
30
32
  across Quant models.
31
33
 
34
+ ## Exposed symbols
35
+
36
+ Some of the package's symbols (i.e. functions, classes, modules, etc.) are exposed via
37
+ `__init__.py` files. They can therefore be imported with a more concise notation that does not
38
+ require specifying their full path.
39
+
40
+ This section references all exposed symbols, and for each one of them, provides an exhaustive
41
+ list of the ways they can be imported.
42
+
43
+ Note: The list below is auto-generated and can be udpated with the following command in the
44
+ terminal:
45
+
46
+ ```cmd
47
+ poetry run python docs.py
48
+ ```
49
+
50
+ ### List of exposed symbols
51
+
52
+ <!-- START EXPOSED SYMBOLS AUTO-GENERATED -->
53
+
54
+ Classes:
55
+
56
+ - `DetDatabase`:
57
+ - `from detquantlib.data import DetDatabase`
58
+ - `from detquantlib.data.databases.detdatabase import DetDatabase`
59
+ - `Entsoe`:
60
+ - `from detquantlib.data import Entsoe`
61
+ - `from detquantlib.data.entsoe.entsoe import Entsoe`
62
+ - `Sftp`:
63
+ - `from detquantlib.data import Sftp`
64
+ - `from detquantlib.data.sftp.sftp import Sftp`
65
+
66
+ <!-- END EXPOSED SYMBOLS AUTO-GENERATED -->
67
+
32
68
  ## Configuration
33
69
 
34
70
  ### Dependencies
detquantlib-3.0.1/detquantlib/data/__init__.py ADDED
@@ -0,0 +1,5 @@
1
+ from .databases.detdatabase import DetDatabase
2
+ from .entsoe.entsoe import Entsoe
3
+ from .sftp.sftp import Sftp
4
+
5
+ __all__ = ["DetDatabase", "Entsoe", "Sftp"]
{detquantlib-3.0.0 → detquantlib-3.0.1}/pyproject.toml RENAMED
@@ -1,6 +1,6 @@
1
1
  [tool.poetry]
2
2
  name = "detquantlib"
3
- version = "3.0.0"
3
+ version = "3.0.1"
4
4
  description = "An internal library containing functions and classes that can be used across Quant models."
5
5
  authors = ["DET"]
6
6
  readme = "README.md"
{detquantlib-3.0.0 → detquantlib-3.0.1}/LICENSE.txt RENAMED
File without changes