jeongukjae / pytistory

📖 Tistory Blog API Client written in Python.

PyTistory

PyTistory는 티스토리 오픈 API 가이드 를 참고하여 Python으로 작성한 티스토리 API 클라이언트입니다. 티스토리 오픈 API 가이드 인증 방식 중 Client-side flow 방식에 따라 구현되었습니다. 자세한 사용법은 PyTistory Documentation 에서 확인하실 수 있습니다.

Installation

pytistory는 pip를 통해 설치할 수 있습니다.

$ pip install pytistory

사용법

사용자 인증

인증정보는 다음과 같은 우선순위를 통해 적용됩니다.

• 직접 설정하는 configure함수로 넘어오는 access_token인자값
• configure함수로 넘어오는 client_id, tistory_id, tistory_password인자값
• configure함수로 넘어오는 file_name에서 읽어들인 인자값
• 환경변수값
• 기본 파일(~/.pytistory/credentials.ini)에 설정되어 있는 값

즉, 환경변수, 기본 설정 파일에 client id가 적용되어 있다 하더라도 직접 넘기는 file_name에 존재하는 설정들에 의해 덮어씌워지고, 직접 인자값으로 넘기는 client_id등의 인자값에 의해 덮어씌워집니다.

access_token이 인자로 넘어올 경우 다른 옵션은 전부 무시하고, access_token만을 설정합니다.

직접 Access Token 설정

from pytistory import PyTistory

pytistory = PyTistory()
pytistory.configure(
  access_token='some-example-access-token')

함수의 인자값을 통한 설정

from pytistory import PyTistory

pytistory = PyTistory()
pytistory.configure(
  client_id='some-example-client-id',
  tistory_id='some-example-tistory-id',
  tistory_password='some-example-tistory-password')

파일을 통한 설정

from pytistory import PyTistory

pytistory = PyTistory()
pytistory.configure(
  file_name='./some/path/to/credentials.ini')

파일 형식은 ini(Initialization)을 따릅니다.

[pytistory]
client_id=some-client-id
tistory_id=some-tistory-id
tistory_password=some-tistory-password

환경변수를 통한 설정

환경 변수로는 다음과 같이 설정할 수 있습니다.

export PYTISTORY_CLIENT_ID=some-example-client-id
export PYTISTORY_TISTORY_ID=some-example-tistory-id
export PYTISTORY_TISTORY_PASSWORD=some-example-tistory-password

API호출

https://www.tistory.com/apis/kind/action 와 같은 api를 호출할 경우 아래처럼 호출합니다.

from pytistory import PyTistory

pytistory = PyTistory()
pytistory.configure()

response = pytistory.kind.action(args...)

예시로 블로그 정보를 받아오는 코드는 아래와 같습니다.

from pytistory import PyTistory

pytistory = PyTistory()
pytistory.configure()

response = pytistory.blog.info()

결과값은 아래처럼 받을 수 있습니다.

{
  "status": "200",
  "id": "[email protected]",
  "item": [
    {
      "url": "http://oauth.tistory.com",
      "secondaryUrl": "http://",
      "nickname": "Tistory API",
      "title": "나만의 앱, Tistory OAuth API 로 만들어보세요!",
      "description": "",
      "default": "Y",
      "blogIconUrl":
        "http://i1.daumcdn.net/cfs.tistory/blog/79/795307/index.gif",
      "faviconUrl":
        "http://i1.daumcdn.net/cfs.tistory/blog/79/795307/index.ico",
      "profileThumbnailImageUrl":
        "http://cfile1.uf.tistory.com/R106x0/1851DB584DAF942950AF29",
      "profileImageUrl":
        "http://cfile1.uf.tistory.com/R106x0/1851DB584DAF942950AF29",
      "statistics": {
        "post": "3",
        "comment": "0",
        "trackback": "0",
        "guestbook": "0",
        "invitation": "0"
      }
    },
    {
      "url": "http://oauth2.tistory.com",
      "secondaryUrl": "http://",
      "nickname": "Tistory API",
      "title": "나만의 비밀 홈",
      "description": "",
      "default": "N",
      "blogIconUrl":
        "http://i1.daumcdn.net/cfs.tistory/blog/79/795308/index.gif",
      "faviconUrl":
        "http://i1.daumcdn.net/cfs.tistory/blog/79/795308/index.ico",
      "profileThumbnailImageUrl": "",
      "profileImageUrl": "",
      "blogId": "795308",
      "statistics": {
        "post": "0",
        "comment": "0",
        "trackback": "0",
        "guestbook": "0",
        "invitation": "0"
      }
    }
  ]
}

기여

이 프로젝트는 부족한 점이 많습니다. Contribution은 언제나 환영입니다. 혹시 오류, 버그 혹은 업데이트가 필요한 점이 있으시다면 PR 또는 Issue 를 통해 언제든지 알려주세요. 👏

Copyright & License

Copyright (c) 2018 JeongUkJae. MIT License.

pytistory's Issues

unittest에서 mocking하기

정말 감사합니다.

이슈로 글을 작성하는게 맞는지는 모르겠지만..
원하던 기능이 모두 구현되어있어서, 생각햇던 기능들 쉽게 구현할수있겠네요.

정말감사합니다^^

추후에 (가능하다면? ㅠㅠ) 저도 사용하다가 공부해서 같이 기여할수있는것들이 있을수있도록 할께요.

CLI 툴 작성 시작하기

list 에서 page 지정

tistory 를 전체 백업을 진행하고있습니다.

현재 list 함수의경우 최신 page 만 지원하는것 같은데요. 혹시 타겟 페이지를 지정할수있는건 어떨까요?
검토부탁드릴께요.

    def list(self, blog_name=None, target_url=None, page_num=None):
        """post/list API 구현입니다.

        최근 게시물 목록을 가져올 수 있는 API입니다. 해당 API에 관한 정보는
        `링크 <http://www.tistory.com/guide/api/post.php#post-list>`_ 를 통해
        살펴보실 수 있습니다.

        :param blog_name: 블로그 명입니다., defaults to None
        :type blog_name: str, optional
        :param target_url: 블로그의 url입니다. deprecated된 옵션입니다., defaults to None
        :type target_url: str, optional
        :param page_num: 리스트를 얻어올 타겟 페이지입니다.
        :type page_num: int, optional
        :raise NoSpecifiedBlog: 블로그 정보를 설정할 수 없을 때 일어납니다.
        :raise TypeError: 인자의 타입이 잘못되었을 때 일어납니다.
        :return:
            `최근 게시글 목록 API <http://www.tistory.com/guide/api/post.php#post-list>`_ 링크에서
            어떤 데이터가 넘어오는 지 알 수 있습니다.
        :rtype: dict
        """
        url = self._get_url(self.kind, 'list')
        params = self._get_default_params()
        self._set_blog_name(params, blog_name, target_url)

        if isinstance(page_num, int) and visibility >= 1:
            params['page'] = page_num
        else:
            raise TypeError('A page_num must be number.')

        response = self._perform('GET', url, params=params)

        return response

추가적인 다른 CI 서버 연결하기

AppVeyor로 생각중

list 함수 page 지정

tistory 를 전체 백업을 진행하고있습니다.

현재 list 함수의경우 최신 page 만 지원하는것 같은데요. 혹시 타겟 페이지를 지정할수있는건 어떨까요?
검토부탁드릴께요.

    def list(self, blog_name=None, target_url=None, page_num=None):
        """post/list API 구현입니다.

        최근 게시물 목록을 가져올 수 있는 API입니다. 해당 API에 관한 정보는
        `링크 <http://www.tistory.com/guide/api/post.php#post-list>`_ 를 통해
        살펴보실 수 있습니다.

        :param blog_name: 블로그 명입니다., defaults to None
        :type blog_name: str, optional
        :param target_url: 블로그의 url입니다. deprecated된 옵션입니다., defaults to None
        :type target_url: str, optional
        :param page_num: 리스트를 얻어올 타겟 페이지입니다.
        :type page_num: int, optional
        :raise NoSpecifiedBlog: 블로그 정보를 설정할 수 없을 때 일어납니다.
        :raise TypeError: 인자의 타입이 잘못되었을 때 일어납니다.
        :return:
            `최근 게시글 목록 API <http://www.tistory.com/guide/api/post.php#post-list>`_ 링크에서
            어떤 데이터가 넘어오는 지 알 수 있습니다.
        :rtype: dict
        """
        url = self._get_url(self.kind, 'list')
        params = self._get_default_params()
        self._set_blog_name(params, blog_name, target_url)

        if isinstance(page_num, int) and visibility >= 1:
            params['page'] = page_num
        else:
            raise TypeError('A page_num must be number.')

        response = self._perform('GET', url, params=params)

        return response