API

Esta parte da documentação cobre todas as interfaces desta API.

cartolafc

Uma API em Python para o Cartola FC.

copyright:(c) 2017 por Vicente Neto. license:MIT, veja LICENSE para mais detalhes.

API

class cartolafc.Api(email=None, password=None, attempts=1, json=False)

Uma API em Python para o Cartola FC

Exemplo de uso:

Para criar uma instância da classe cartolafc.Api, sem autenticação:

>>> import cartolafc
>>> api = cartolafc.Api()

Para obter o status atual do mercado

>>> mercado = api.mercado()
>>> print(mercado.rodada_atual, mercado.status.nome)

Para utilizar autenticação, é necessário instancias a classe cartolafc.Api com os argumentos email e senha.

>>> api =  cartolafc.Api(email='usuario@email.com', password='s3nha')

Para obter os dados de uma liga (após se autenticar), onde “nome” é o nome da liga que deseja buscar:

>>> liga = api.liga(nome)
>>> print(liga.nome)

python-cartolafc é massa!!! E possui muitos outros métodos, como:

>>> api.mercado()
>>> api.time(nome, slug)
>>> api.busca_times(termo)

ligas(query)

Retorna o resultado da busca ao Cartola por um determinado termo de pesquisa.

Args:

query (str): Termo para utilizar na busca.

Returns:

Uma lista de instâncias de cartolafc.Liga, uma para cada liga contento o termo utilizado na busca.

mercado()

Obtém o status do mercado na rodada atual.

Returns:

Uma instância de cartolafc.Mercado representando o status do mercado na rodada atual.

parciais()

Obtém um mapa com todos os atletas que já pontuaram na rodada atual (aberta).

Returns:

Uma mapa, onde a key é um inteiro representando o id do atleta e o valor é uma instância de cartolafc.Atleta

Raises:

CartolaFCError: Se o mercado atual estiver com o status fechado.

set_credentials(email, password)

Realiza a autenticação no sistema do CartolaFC utilizando o email e password informados.

Args:

email (str): O email do usuário password (str): A senha do usuário

Raises:

cartolafc.CartolaFCError: Se o conjunto (email, password) não conseguiu realizar a autenticação com sucesso.

time(id=None, nome=None, slug=None)

Obtém um time específico, baseando-se no nome ou no slug utilizado. Ao menos um dos dois devem ser informado.

Args:

id (int): Id to time que se deseja obter. Este argumento sempre será utilizado primeiro nome (str): Nome do time que se deseja obter. Requerido se o slug não for informado. slug (str): Slug do time que se deseja obter. Este argumento tem prioridade sobre o nome

Returns:

Uma instância de cartolafc.Time se o time foi encontrado.

Raises:

cartolafc.CartolaFCError: Se algum erro aconteceu, como por exemplo: Nenhum time foi encontrado.

times(query)

Retorna o resultado da busca ao Cartola por um determinado termo de pesquisa.

Args:

query (str): Termo para utilizar na busca.

Returns:

Uma lista de instâncias de cartolafc.TimeInfo, uma para cada time contento o termo utilizado na busca.

Erros

class cartolafc.CartolaFCError

Classe base para os erros da API do Cartola FC

class cartolafc.CartolaFCOverloadError

Erro lançado quando o servidores estão sobrecarregados e a biblioteca não consegue obter os dados requisitados

Modelos

class cartolafc.models.Atleta(atleta_id, apelido, pontos, scout, posicao_id, clube, status_id=None)

Representa um atleta (jogador ou técnico), e possui informações como o apelido, clube e pontuação obtida

class cartolafc.models.Clube(id, nome, abreviacao)

Representa um dos 20 clubes presentes no campeonato, e possui informações como o nome e a abreviação

class cartolafc.models.DestaqueRodada(media_cartoletas, media_pontos, mito_rodada)

Destaque Rodada

class cartolafc.models.Liga(liga_id, nome, slug, descricao, times)

class cartolafc.models.LigaPatrocinador(liga_id, nome, url_link)

Liga Patrocinador

class cartolafc.models.Mercado(rodada_atual, status_mercado, times_escalados, aviso, fechamento)

class cartolafc.models.PontuacaoInfo(atleta_id, rodada_id, pontos, preco, variacao, media)

Pontuação Info

class cartolafc.models.Time(patrimonio, valor_time, ultima_pontuacao, atletas, info)

class cartolafc.models.TimeInfo(time_id, nome, nome_cartola, slug, assinante, pontos)

Time Info