Skip to content

Commit f94d818

Browse files
author
Aaron Gonzales
committed
fixing sphinx builds to include renamed files
1 parent e6b872d commit f94d818

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

README.rst

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Python Twitter Search API
33

44
This library serves as a python interface to the `Twitter premium and enterprise search APIs <https://developer.twitter.com/en/docs/tweets/search/overview/30-day-search>`_. It provides a command-line utility and a library usable from within python. It comes with tools for assisting in dynamic generation of search rules and for parsing tweets.
55

6-
Pretty docs can be seen `here <https://twitterdev.github.io/twitter_search_api/>`_.
6+
Pretty docs can be seen `here <https://twitterdev.github.io/search_tweets_api/>`_.
77

88

99
Features
@@ -22,26 +22,26 @@ Features
2222
Installation
2323
============
2424

25-
We will soon handle releases via PyPy, but you can also install the current master version via
25+
We will host the package on PyPi so it's pip-friendly.
2626

2727
.. code:: bash
2828
29-
pip install git+https://github.com/twitterdev/twitter_search_api.git
29+
pip install searchtweets
3030
3131
Or the development version locally via
3232

3333
.. code:: bash
3434
35-
git clone https://github.com/twitterdev/twitter_search_api.git
36-
cd twitter_search_api
35+
git clone https://github.com/twitterdev/search-tweets-python
36+
cd search-tweets-python
3737
pip install -e .
3838
3939
4040
4141
Using the Comand Line Application
4242
=================================
4343

44-
We provide a utility, ``twitter_search.py``, in the ``tools`` directory that provides rapid access to tweets.
44+
We provide a utility, ``search_tweets.py``, in the ``tools`` directory that provides rapid access to tweets.
4545
Premium customers should use ``--bearer-token``; enterprise customers should use ``--user-name`` and ``--password``.
4646

4747
The ``--endpoint`` flag will specify the full URL of your connection, e.g.:
@@ -61,7 +61,7 @@ Note that the ``--results-per-call`` flag specifies an argument to the API call
6161

6262
.. code:: bash
6363
64-
python twitter_search.py \
64+
python search_tweets.py \
6565
--bearer-token <BEARER_TOKEN> \
6666
--endpoint <MY_ENDPOINT> \
6767
--max-results 1000 \
@@ -74,7 +74,7 @@ Note that the ``--results-per-call`` flag specifies an argument to the API call
7474

7575
.. code:: bash
7676
77-
python twitter_search.py \
77+
python search_tweets.py \
7878
--user-name <USERNAME> \
7979
--password <PW> \
8080
--endpoint <MY_ENDPOINT> \
@@ -89,7 +89,7 @@ Note that the ``--results-per-call`` flag specifies an argument to the API call
8989

9090
.. code:: bash
9191
92-
python twitter_search.py \
92+
python search_tweets.py \
9393
--user-name <USERNAME> \
9494
--password <PW> \
9595
--endpoint <MY_ENDPOINT> \
@@ -134,7 +134,7 @@ When using a config file in conjunction with the command-line utility, you need
134134

135135
Example::
136136

137-
python twitter_search_api.py \
137+
python search_tweets.py \
138138
--config-file myapiconfig.config \
139139
--no-print-stream
140140

@@ -160,7 +160,7 @@ Your credentials should be put into a YAML file that looks like this:
160160
.. code:: yaml
161161
162162
163-
twitter_search_api:
163+
search_tweets_api:
164164
endpoint: <FULL_URL_OF_ENDPOINT>
165165
account: <ACCOUNT_NAME>
166166
username: <USERNAME>
File renamed without changes.

0 commit comments

Comments
 (0)