forked from areed1192/python-sec
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathsetup.py
More file actions
80 lines (56 loc) · 2.53 KB
/
Copy pathsetup.py
File metadata and controls
80 lines (56 loc) · 2.53 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
from setuptools import setup, find_packages
# load the README file.
with open(file="README.md", mode="r") as readme_file:
long_description = readme_file.read()
setup(
# this will be my Library name.
name='python-sec',
# Want to make sure people know who made it.
author='Alex Reed',
# also an email they can use to reach out.
author_email='coding.sigma@gmail.com',
# I'm in alpha development still, so a compliant version number is a1.
# read this as MAJOR VERSION 0, MINOR VERSION 1, MAINTENANCE VERSION 0
version='0.1.1',
# here is a simple description of the library, this will appear when someone searches for the library on https://pypi.org/search
description='A client library for collecting and scraping SEC filings.',
# I have a long description but that will just be my README file, note the variable up above where I read the file.
long_description=long_description,
# want to make sure that I specify the long description as MARKDOWN.
long_description_content_type="text/markdown",
# here is the URL you can find the code, this is just the GitHub URL.
url='https://github.com/areed1192/python-sec',
# there are some dependencies to use the library, so let's list them out.
install_requires=[
'requests>=2.24.0',
'urllib3==1.25.9',
'beautifulsoup4==4.9.1'
],
# some keywords for my library.
keywords='finance, sec, api, web scraping, financial disclosures',
# here are the packages I want "build."
packages=find_packages(include=['pysec']),
# here we specify any package data.
package_data={
"pysec": ["parsing/*"],
},
# I also have some package data, like photos and JSON files, so I want to include those too.
include_package_data=True,
# additional classifiers that give some characteristics about the package.
classifiers=[
# I want people to know it's still early stages.
'Development Status :: 3 - Alpha',
# My Intended audience is mostly those who understand finance.
'Intended Audience :: Financial and Insurance Industry',
# My License is MIT.
'License :: OSI Approved :: MIT License',
# I wrote the client in English
'Natural Language :: English',
# The client should work on all OS.
'Operating System :: OS Independent',
# The client is intendend for PYTHON 3
'Programming Language :: Python :: 3'
],
# you will need python 3.7 to use this libary.
python_requires='>=3.7'
)