sgs

v2.1.1

Python wrapper para o webservice do SGS - Sistema Gerenciador de Series Temporais do Banco Central do Brasil. For more information about how to use this package see README

Latest version published 3 years ago

License: MIT

PyPI

GitHub

Package Health Score

45 / 100

security
Security review needed
popularity
Small
maintenance
Inactive
community
Sustainable

Explore Similar Packages

Popularity

Small

GitHub Stars: 74
Forks: 16
Contributors: 4

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package sgs, we found that it has been starred 74 times.

Security

Security review needed

Security and license risk for latest version

Release Date: Aug 31, 2021
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
1
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

MIT

Security Policy

We found a way for you to contribute to the project! Looks like sgs is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 1
Open PR: 1
Last Release: 3 years ago
Last Commit: 3 years ago

Further analysis of the maintenance status of sgs based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for sgs is that it hasn't seen any new versions released to PyPI in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Sustainable

Readme: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 4
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like sgs is missing a Code of Conduct.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: >=3.5

Age: 7 years
Latest Release: 3 years ago
Dependencies: 5 Direct / 15 Total
Versions: 30
Maintainers: 0
Wheels: OS Independent

Readme

SGS

Introduction

This library provides a pure Python interface for the Brazilian Central Bank's Time Series Management System (SGS) api. It works with Python 3.5 and above.

SGS is a service with more than 18,000 time series with economical and financial information. This library is intended to make it easier for Python programmers to use this data in projects of any kind, providing mechanisms to search for, extract and join series.

Quickstart

Access time series data with sgs is very simple

Begin by importing the sgs module:

import sgs

Now, let's try to get a time serie. For this example, let's get the "Interest rate - CDI" time serie in 2018, wich has the code 12.

CDI_CODE = 12
ts = sgs.time_serie(CDI_CODE, start='02/01/2018', end='31/12/2018')

Now, we have a Pandas Series object called ts, with all the data and the index representing the dates.

ts.head()

2018-01-02	0.026444
2018-01-03	0.026444
2018-01-04	0.026444
2018-01-05	0.026444
2018-01-08	0.026444

Feature Suport

Get time serie data with an one-liner using sgs.time_serie
Create a dataframe from a list of time series codes with sgs.dataframe
Search time series by text or code with sgs.search_ts
Get metadata from all the series in a dataframe using sgs.metadata
Support to search and metadata in English and Portuguese
Automatic retry
Automatic cached requests

Installation

To install, simply use pip:

$ pip install sgs

Documentation

Complete documentation is available at .

sgs dependencies

beautifulsoup4 html5lib pandas requests retrying

FAQs

What is sgs?

Python wrapper para o webservice do SGS - Sistema Gerenciador de Series Temporais do Banco Central do Brasil. Visit Snyk Advisor to see a full health score report for sgs, including popularity, security, maintenance & community analysis.

Is sgs popular?

The python package sgs receives a total of 1,005 weekly downloads. As such, sgs popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is sgs well maintained?

We found indications that sgs is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is sgs safe to use?

While scanning the latest version of sgs, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 27 December-2024, at 13:41 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP