#Script Pages

<back to all web services

QueryGitHubRepos

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryBase:
    skip: Optional[int] = None
    take: Optional[int] = None
    order_by: Optional[str] = None
    order_by_desc: Optional[str] = None
    include: Optional[str] = None
    fields: Optional[str] = None
    meta: Optional[Dict[str, str]] = None


T = TypeVar('T')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryData(Generic[T], QueryBase, IReturn[QueryResponse[T]]):
    @staticmethod
    def response_type(): return QueryResponse[T]


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GithubUser:
    id: int = 0
    login: Optional[str] = None
    avatar__url: Optional[str] = None
    url: Optional[str] = None
    followers: Optional[int] = None
    following: Optional[int] = None
    type: Optional[str] = None
    public__gists: Optional[int] = None
    location: Optional[str] = None
    company: Optional[str] = None
    html__url: Optional[str] = None
    public__repos: Optional[int] = None
    created__at: Optional[datetime.datetime] = None
    blog: Optional[str] = None
    email: Optional[str] = None
    name: Optional[str] = None
    hireable: Optional[bool] = None
    gravatar__id: Optional[str] = None
    bio: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GithubRepo:
    id: int = 0
    name: Optional[str] = None
    description: Optional[str] = None
    homepage: Optional[str] = None
    language: Optional[str] = None
    watchers__count: int = 0
    stargazes__count: int = 0
    forks__count: int = 0
    open__issues__count: int = 0
    size: int = 0
    full__name: Optional[str] = None
    created_at: datetime.datetime = datetime.datetime(1, 1, 1)
    pushed__at: Optional[datetime.datetime] = None
    updated__at: Optional[datetime.datetime] = None
    has_issues: bool = False
    has__downloads: bool = False
    has__wiki: bool = False
    has__pages: bool = False
    fork: bool = False
    owner: Optional[GithubUser] = None
    svn__url: Optional[str] = None
    mirror__url: Optional[str] = None
    url: Optional[str] = None
    ssh__url: Optional[str] = None
    html__url: Optional[str] = None
    clone__url: Optional[str] = None
    git__url: Optional[str] = None
    private: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryGitHubRepos(QueryData[GithubRepo]):
    user_name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Order:
    order_id: int = 0
    customer_id: Optional[str] = None
    order_date: datetime.datetime = datetime.datetime(1, 1, 1)
    total: float = 0.0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Customer:
    customer_id: Optional[str] = None
    company_name: Optional[str] = None
    address: Optional[str] = None
    city: Optional[str] = None
    region: Optional[str] = None
    postal_code: Optional[str] = None
    country: Optional[str] = None
    phone: Optional[str] = None
    fax: Optional[str] = None
    orders: Optional[List[Order]] = None


Customer = TypeVar('Customer')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryResponse(Generic[Customer]):
    offset: int = 0
    total: int = 0
    results: Optional[List[Customer]] = None
    meta: Optional[Dict[str, str]] = None
    response_status: Optional[ResponseStatus] = None

Python QueryGitHubRepos DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /csv/reply/QueryGitHubRepos HTTP/1.1 
Host: sharpscript.net 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"userName":"String","skip":0,"take":0,"orderBy":"String","orderByDesc":"String","include":"String","fields":"String","meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"offset":0,"total":0,"results":[{"id":0,"name":"String","description":"String","homepage":"String","language":"String","watchers_Count":0,"stargazes_Count":0,"forks_Count":0,"open_Issues_Count":0,"size":0,"full_Name":"String","created_at":"\/Date(-62135596800000-0000)\/","pushed_At":"\/Date(-62135596800000-0000)\/","updated_At":"\/Date(-62135596800000-0000)\/","has_issues":false,"has_Downloads":false,"has_Wiki":false,"has_Pages":false,"fork":false,"owner":{"id":0,"login":"String","avatar_Url":"String","url":"String","followers":0,"following":0,"type":"String","public_Gists":0,"location":"String","company":"String","html_Url":"String","public_Repos":0,"created_At":"\/Date(-62135596800000-0000)\/","blog":"String","email":"String","name":"String","hireable":false,"gravatar_Id":"String","bio":"String"},"svn_Url":"String","mirror_Url":"String","url":"String","ssh_Url":"String","html_Url":"String","clone_Url":"String","git_Url":"String","private":false}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}