Package Search Help

You can use boolean logic (e.g. AND/OR/NOT) for complex search queries. For more help and examples, see the search documentation.

Search by package name:
my-package (implicit)
name:my-package (explicit)

Search by package filename:
filename:my-package.ext 

Search by package tag:
tag:latest 

Search by package version:
version:1.0.0  prerelease:true (prereleases)
prerelease:false (no prereleases)

Search by package architecture:
architecture:x86_64 

Search by package distribution:
distribution:el 

Search by package license:
license:MIT 

Search by package format:
format:deb 

Search by package status:
status:in_progress 

Search by package file checksum:
checksum:5afba 

Search by package security status:
severity:critical 

Search by package vulnerabilities:
vulnerabilities:>1 
vulnerabilities:<1000 

Search by # of package downloads:
downloads:>8 
downloads:<100 

Search by package type:
type:binary 
type:source 

Search by package size (bytes):
size:>50000 
size:<10000 

Search by dependency name/version:
dependency:log4j 
dependency:log4j=1.0.0 
dependency:log4j>1.0.0 

Search by uploaded date:
uploaded:>"1 day ago" 
uploaded:<"August 14, 2022 EST" 

Search by entitlement token (identifier):
entitlement:3lKPVJPosCsY 

Search by policy violation:
policy_violated:true
deny_policy_violated:true
license_policy_violated:true
vulnerability_policy_violated:true

Search by repository:
repository:repo-name

Search by last download date:
last_downloaded:<"30 days ago" 
last_downloaded:>"August 14, 2022 EST" 

Search queries for all Debian-specific (and related) package types

Search by component:
deb_component:unstable

Search queries for all Maven-specific (and related) package types

Search by group ID:
maven_group_id:org.apache

Search queries for all Docker-specific (and related) package types

Search by image digest:
docker_image_digest:sha256:7c5..6d4
(full hashref only)

Search by layer digest:
docker_layer_digest:sha256:4c4..ae4
(full hashref only)

Search queries for all Generic-specific package types

Search by file path:
generic_filepath:path/to/file.txt

Search by directory:
generic_directory:path/to

Field type modifiers (depending on the type, you can influence behaviour)

For all queries, you can use:
~foo for negation

For string queries, you can use:
^foo to anchor to start of term
foo$ to anchor to end of term
foo*bar for fuzzy matching

For number/date or version queries, you can use:
>foo for values greater than
>=foo for values greater / equal
<foo for values less than
<=foo for values less / equal

Need a secure and centralised artifact repository to deliver Alpine, Cargo, CocoaPods, Composer, Conan, Conda, CRAN, Dart, Debian, Docker, Generic, Go, Helm, Hex, HuggingFace, LuaRocks, Maven, npm, NuGet, P2, Python, RedHat, Ruby, Swift, Terraform, Vagrant, VSX, Raw & More packages?

Cloudsmith is the new standard in Package / Artifact Management and Software Distribution.

With support for all major package formats, you can trust us to manage your software supply chain.

Start My Free Trial

Python logo Brainrot-Stocks  0.1.4

One-liner (summary)

Get stock data with unwanted brainrot in your Python app.

Description

![Build & Test](https://github.com/software-students-fall2024/3-python-package-financeeers/actions/workflows/python-package.yml/badge.svg)

# Brainrot-Stocks

An exercise to create a Python package, build it, test it, distribute it, and use it. See [instructions](./instructions.md) for details.

This package was created by generally following the [Packaging Python Projects](https://packaging.python.org/en/latest/tutorials/packaging-projects/) with the addition of some pipenv setup to manage [virtual environments](https://packaging.python.org/en/latest/tutorials/managing-dependencies/).

## Project Description

Brainrot-Stocks is a Python package designed for handling financial data. It includes modules for managing stock quotes, performing various operations on financial data, and engaging learning experiences.

## Link to Package on PYPI

https://pypi.org/project/Brainrot-Stocks/#description

## Team members

|Reyhan Abdul Quayum|Rashed Alneyadi|Sia Chen|Yu Zhang|Chloe Han| |:--:|:--:|:--:|:--:|:--:| |<a href='https://github.com/reyhanquayum'><img src='https://avatars.githubusercontent.com/u/115737572?v=4' width='40px'/></a>|<a href='https://github.com/brshood'><img src='https://avatars.githubusercontent.com/u/133962779?v=4' width='40px'/></a>|<a href='https://github.com/MambiChen'><img src='https://avatars.githubusercontent.com/u/122314736?v=4' width='40px'/></a>|<a href='https://github.com/yz7669'><img src='https://avatars.githubusercontent.com/u/180553323?v=4' width='40px'/></a>|<a href='https://github.com/jh7316'><img src='https://avatars.githubusercontent.com/u/95545960?s=88&v=4' width='40px'/></a>|

## Project Structure

  • src/Financiers Contains the main modules: - quotes.py: Handles operations related to stock quotes. - stock.py: Manages stock data and related functionality.
  • tests Contains test files for validating the code. - test_stock.py: Tests the stock.py module.

## How to install and use this package Prerequisites: have latest versions of pip and python installed on your environment.

1. Navigate to your project directory. Create a virtual environment using pipenv, and install the latest version of the package with the following command:

`bash pip install pipenv pipenv install Brainrot-Stocks ` And before moving onto the next step, activate the virtual environment:

`bash pipenv shell `

2. Import the package using the following command inside the file: `python from Financiers.stock import Stock ` Then, create an instance of Stock class:

`python stock = Stock() `

And you're ready to go! Refer to this [example file](https://github.com/software-students-fall2024/3-python-package-financeeers/blob/main/example_usage.py) to see the example usage of package functions inside the code.

3. Run the program (replace <example_file> with your actual file name): `bash python <example_file>.py `

## Contribute to the project Prerequisites: have latest versions of pip and python installed on your environment.

### Environment Setup

  1. Clone the repository:
```bash git clone https://github.com/software-students-fall2024/3-python-package-financeeers.git cd 3-python-package-financeeers

```

  1. Install pipenv:

If pipenv has not been installed, install using the following command: `bash pip install pipenv `

3. Create and Activate virtual environment: `bash pipenv install pipenv shell `

4. Add .env file: create .env file in the root directory of the project, and add the following content: `python ALPHAVANTAGE_API_KEY = <api_key> ` Replace <api_key> with the actual api key, which will be delivered to the admins via discord.

### Make contribution 1. Modify & Run the file:

Make changes you want to make, and run the files. For example, if you want to run stock.py, run the following command: `bash python src/Financiers/stock.py `

### Test & Build Make sure you are in the virtual environment by running the following command: `bash pipenv shell ` 1. Test

Run all unit tests with the following command: `bash pytest `

  1. Build

Build the package using the following command: `bash python -m build ` Then, the artifacts will be produced at dist/.

If you want to exit the virtual environment, use this comand: `bash exit `

Size

35.5 KB

Downloads

5

Status  Completed
Checksum (MD5) 8e5b042022ccc9f1b393679ccc6a8ea3
Checksum (SHA-1) ab7e2c88af14bd1b66c88a5d8b89eff2815ea32c
Checksum (SHA-256) 9226f2b2b8d06e20cf2b94f895d0a219c90eb5bd695f83e0cc7f0bb62002cab9
Checksum (SHA-512) f44a2494f8c58345811ddd8591b6a90fbdb6cdce6cc28a6936d184926f4987d27f…
GPG Signature
GPG Fingerprint 6811684bac0b8895434e97bdd4391b8fb999e537
Storage Region  Dublin, Ireland
Type  Binary (contains binaries and binary artifacts)
Uploaded At 4 months, 3 weeks ago
Uploaded By Fetched by Cloudsmith
Slug Id brainrot_stocks-014-py3-none-anywhl-6g4o
Unique Id ZpnOdABBLchaD3m8
Version (Raw) 0.1.4
Version (Parsed)
  • Major: 0
  • Minor: 1
  • Patch: 4
  • Type: SemVer (Compat)
  extended metadata
Author Unset
Classifiers Intended Audience :: Developers | License :: OSI Approved :: GNU General Public License v3 (GPLv3) | Operating System :: OS Independent | Programming Language :: Python :: 3 | Topic :: Software Development :: Libraries :: Python Modules
Keywords python,package,finance,stocks,API
Metadata Version 2.1
Project Urls Bug Tracker, https://github.com/software-students-fall2024/3-python-package-fin… | Homepage, https://github.com/software-students-fall2024/3-python-package-financ… | Repository, https://github.com/software-students-fall2024/3-python-package-fina…
Py Filetype bdist_wheel
Py Version py3
Requires Dist datetime | matplotlib | numpy | pandas | pytest; extra == "dev" | python-dotenv | requests
Requires Python >=3.7
pkg Brainrot_Stocks-0.1.4-py3-none-… 5
35.5 KB
md5 sha1 sha256 sha512
Package Contents (Brainrot_Stocks-0.1.4-py3-none-any.whl)
Loading...

This package has 12 files/directories.

Last scanned

4 months, 3 weeks ago

Scan result

Clean

Vulnerability count

0

Max. severity

Unknown

You can embed a badge in another website that shows this or the latest version of this package.

To embed the badge for this specific package version, use the following:

[![This version of 'Brainrot-Stocks' @ Cloudsmith](https://api.cloudsmith.com/v1/badges/version/demo-docs/awesome-repo/python/Brainrot-Stocks/0.1.4/a=noarch;xf=bdist_wheel;xn=brainrot-stocks;xv=py3/?render=true)](https://cloudsmith.io/~demo-docs/repos/awesome-repo/packages/detail/python/Brainrot-Stocks/0.1.4/a=noarch;xf=bdist_wheel;xn=brainrot-stocks;xv=py3/)
|This version of 'Brainrot-Stocks' @ Cloudsmith|
.. |This version of 'Brainrot-Stocks' @ Cloudsmith| image:: https://api.cloudsmith.com/v1/badges/version/demo-docs/awesome-repo/python/Brainrot-Stocks/0.1.4/a=noarch;xf=bdist_wheel;xn=brainrot-stocks;xv=py3/?render=true
   :target: https://cloudsmith.io/~demo-docs/repos/awesome-repo/packages/detail/python/Brainrot-Stocks/0.1.4/a=noarch;xf=bdist_wheel;xn=brainrot-stocks;xv=py3/
image::https://api.cloudsmith.com/v1/badges/version/demo-docs/awesome-repo/python/Brainrot-Stocks/0.1.4/a=noarch;xf=bdist_wheel;xn=brainrot-stocks;xv=py3/?render=true[link="https://cloudsmith.io/~demo-docs/repos/awesome-repo/packages/detail/python/Brainrot-Stocks/0.1.4/a=noarch;xf=bdist_wheel;xn=brainrot-stocks;xv=py3/",title="This version of 'Brainrot-Stocks' @ Cloudsmith"]
<a href="https://cloudsmith.io/~demo-docs/repos/awesome-repo/packages/detail/python/Brainrot-Stocks/0.1.4/a=noarch;xf=bdist_wheel;xn=brainrot-stocks;xv=py3/"><img src="https://api.cloudsmith.com/v1/badges/version/demo-docs/awesome-repo/python/Brainrot-Stocks/0.1.4/a=noarch;xf=bdist_wheel;xn=brainrot-stocks;xv=py3/?render=true" alt="This version of 'Brainrot-Stocks' @ Cloudsmith" /></a>

rendered as: This version of 'Brainrot-Stocks' @ Cloudsmith

To embed the badge for the latest package version, use the following:

[![Latest version of 'Brainrot-Stocks' @ Cloudsmith](https://api.cloudsmith.com/v1/badges/version/demo-docs/awesome-repo/python/Brainrot-Stocks/latest/a=noarch;xf=bdist_wheel;xn=brainrot-stocks;xv=py3/?render=true&show_latest=true)](https://cloudsmith.io/~demo-docs/repos/awesome-repo/packages/detail/python/Brainrot-Stocks/latest/a=noarch;xf=bdist_wheel;xn=brainrot-stocks;xv=py3/)
|Latest version of 'Brainrot-Stocks' @ Cloudsmith|
.. |Latest version of 'Brainrot-Stocks' @ Cloudsmith| image:: https://api.cloudsmith.com/v1/badges/version/demo-docs/awesome-repo/python/Brainrot-Stocks/latest/a=noarch;xf=bdist_wheel;xn=brainrot-stocks;xv=py3/?render=true&show_latest=true
   :target: https://cloudsmith.io/~demo-docs/repos/awesome-repo/packages/detail/python/Brainrot-Stocks/latest/a=noarch;xf=bdist_wheel;xn=brainrot-stocks;xv=py3/
image::https://api.cloudsmith.com/v1/badges/version/demo-docs/awesome-repo/python/Brainrot-Stocks/latest/a=noarch;xf=bdist_wheel;xn=brainrot-stocks;xv=py3/?render=true&show_latest=true[link="https://cloudsmith.io/~demo-docs/repos/awesome-repo/packages/detail/python/Brainrot-Stocks/latest/a=noarch;xf=bdist_wheel;xn=brainrot-stocks;xv=py3/",title="Latest version of 'Brainrot-Stocks' @ Cloudsmith"]
<a href="https://cloudsmith.io/~demo-docs/repos/awesome-repo/packages/detail/python/Brainrot-Stocks/latest/a=noarch;xf=bdist_wheel;xn=brainrot-stocks;xv=py3/"><img src="https://api.cloudsmith.com/v1/badges/version/demo-docs/awesome-repo/python/Brainrot-Stocks/latest/a=noarch;xf=bdist_wheel;xn=brainrot-stocks;xv=py3/?render=true&show_latest=true" alt="Latest version of 'Brainrot-Stocks' @ Cloudsmith" /></a>

rendered as: Latest version of 'Brainrot-Stocks' @ Cloudsmith

These instructions assume you have setup the repository first (or read it).

To install/use Brainrot-Stocks @ version 0.1.4 ...

pip install 'Brainrot-Stocks==0.1.4'

You can also install the latest version of this package:

pip install --upgrade 'Brainrot-Stocks'

If necessary, you can specify the repository directly:

pip install \
  --index-url=https://dl.cloudsmith.io/public/demo-docs/awesome-repo/python/simple/ \
  Brainrot-Stocks==0.1.4

If you've got a project requirements.txt file, you can specify this as a dependency:

--index-url=https://dl.cloudsmith.io/public/demo-docs/awesome-repo/python/simple/
Brainrot-Stocks==0.1.4

In addition, you can use this repository as an extra index url. However, please read our documentation on this parameter before using it. For example in a requirements.txt file:

--extra-index-url=https://dl.cloudsmith.io/public/demo-docs/awesome-repo/python/simple/
Brainrot-Stocks==0.1.4
Warning: We highly recommend using pip (or similar) rather than installing directly.
Top