Metadata-Version: 2.1
Name: econkit
Version: 0.2.7.1
Summary: Advanced Econometric Analysis Tools
Home-page: https://www.stefanstavrianos.eu/
Author: Stefanos Stavrianos
Author-email: contact@stefanstavrianos.eu
License: BSD 3-Clause License
        
        Copyright (c) 2023, Stefanos Stavrianos
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright
           notice, this list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright
           notice, this list of conditions and the following disclaimer in the
           documentation and/or other materials provided with the distribution.
        
        3. Neither the name of the project nor the names of its
           contributors may be used to endorse or promote products derived from
           this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
        
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Office/Business :: Financial
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: scipy
Requires-Dist: yfinance
Requires-Dist: matplotlib

<h1>EconKit Package</h1>

<p>This is a detailed description of the EconKit package. It provides advanced tools and functions for econometric analysis, tailored to the needs of researchers, students, and professionals in economics and finance.</p>

<h2>Installation</h2>

<p>To install the EconKit package, run the following command:</p>

<pre><code>pip install econkit</code></pre>

<h2>Usage</h2>

<p>Here's how to use the main functions in the package:</p>

<pre><code>### EXAMPLE ###

## Import Libraries ##
from econkit import descriptives
from econkit import correlation
from econkit import stock
from econkit import table


### Run ###

# 1. Download Stock Information #
# 1.1 Stocks #
stock1 = 'ETE.AT'
stock2 = 'LAVI.AT'
stock3 = 'TPEIR.AT'
stock4 = 'EKTER.AT'
stock5 = 'TRESTATES.AT'
stock6 = 'INKAT.AT'
stock7 = 'EXAE.AT'


# 1.2 Preiod #
start = '01-12-2022'
end = '30-12-2023'

# 1.3 Frequency #
freq = '1d'

# 1.4 Function #
stock(stock1, start, end, freq)
stock(stock2, start, end, freq)
stock(stock3, start, end, freq)
stock(stock4, start, end, freq)
stock(stock5, start, end, freq)
stock(stock6, start, end, freq)
stock(stock7, start, end, freq)


# 2. Combine Multiple Stocks' Returns into One Table #
Returns = table('Returns', ETE, LAVI, TPEIR, EKTER, TRESTATES, INKAT, EXAE)

# 3. Find Useful Statistics, such as Expected Values, Standard Deviation,... "
descriptives(Returns)
correlation(Returns, method="Spearman", p="T")
</code></pre>

<h2>Features</h2>

<ul>
  <li>Comprehensive econometric analysis tools</li>
  <li>Support for various correlation methods</li>
  <li>User-friendly interface for complex statistical operations</li>
</ul>

<h2>Requirements</h2>

<p>The package requires the following Python libraries:</p>

<ul>
  <li>Numpy</li>
  <li>Pandas</li>
  <li>Scipy</li>
</ul>

<h2>Contributing</h2>

<p>We welcome contributions to the EconKit package. Please read the contributing guidelines before submitting your pull requests.</p>

<h2>License</h2>

<p>This project is licensed under the BSD 3-Clause License - see the <a href="LICENSE">LICENSE</a> file for details.</p>

<h2>Acknowledgments</h2>

<p>Special thanks to all contributors and supporters of the project.</p>

<h2>Contact</h2>

<p>For questions or support, please contact <a href="mailto:contact@stfanstavrianos.eu">contact@stfanstavrianos.eu</a>.</p>

