"src/main/webapp/vscode:/vscode.git/clone" did not exist on "7fb6775dba1ff089420a19ca81df2a9a21083b72"
Unverified Commit 8940786d authored by Dave Machado's avatar Dave Machado
Browse files

Add build check for title ending with "API"

every entry in this project is an API, so specifying adds nothing
meaningful
parent 367de578
...@@ -112,7 +112,7 @@ API | Description | Auth | HTTPS | Link | ...@@ -112,7 +112,7 @@ API | Description | Auth | HTTPS | Link |
API | Description | Auth | HTTPS | Link | API | Description | Auth | HTTPS | Link |
|---|---|---|---|---| |---|---|---|---|---|
| Charity Search | Non-profit charity data | `apiKey` | No | [Go!](http://charityapi.orghunter.com/) | | Charity Search | Non-profit charity data | `apiKey` | No | [Go!](http://charityapi.orghunter.com/) |
| Clearbit Logo API | Search for company logos and embed them in your projects | No | Yes | [Go!](https://clearbit.com/docs#logo-api) | | Clearbit Logo | Search for company logos and embed them in your projects | No | Yes | [Go!](https://clearbit.com/docs#logo-api) |
| Domainsdb.info | Registered Domain Names Search | No | Yes | [Go!](https://domainsdb.info/) | | Domainsdb.info | Registered Domain Names Search | No | Yes | [Go!](https://domainsdb.info/) |
| Gmail | Flexible, RESTful access to the user's inbox | `OAuth` | Yes | [Go!](https://developers.google.com/gmail/api/) | | Gmail | Flexible, RESTful access to the user's inbox | `OAuth` | Yes | [Go!](https://developers.google.com/gmail/api/) |
| Google Analytics | Collect, configure, and analyze your data to reach the right audience | `OAuth` | Yes | [Go!](https://developers.google.com/analytics/) | | Google Analytics | Collect, configure, and analyze your data to reach the right audience | `OAuth` | Yes | [Go!](https://developers.google.com/analytics/) |
...@@ -207,7 +207,7 @@ API | Description | Auth | HTTPS | Link | ...@@ -207,7 +207,7 @@ API | Description | Auth | HTTPS | Link |
| IPinfo | Another simple IP Address API | No | Yes | [Go!](https://ipinfo.io/developers) | | IPinfo | Another simple IP Address API | No | Yes | [Go!](https://ipinfo.io/developers) |
| JSON 2 JSONP | Convert JSON to JSONP (on-the-fly) for easy cross-domain data requests using client-side JavaScript | No | Yes | [Go!](https://json2jsonp.com/) | | JSON 2 JSONP | Convert JSON to JSONP (on-the-fly) for easy cross-domain data requests using client-side JavaScript | No | Yes | [Go!](https://json2jsonp.com/) |
| JSONbin.io | Free JSON storage service. Ideal for small scale Web apps, Websites and Mobile apps | `apiKey` | Yes | [Go!](https://jsonbin.io) | | JSONbin.io | Free JSON storage service. Ideal for small scale Web apps, Websites and Mobile apps | `apiKey` | Yes | [Go!](https://jsonbin.io) |
| Judge0 API | Compile and run source code | No | Yes | [Go!](https://api.judge0.com/) | | Judge0 | Compile and run source code | No | Yes | [Go!](https://api.judge0.com/) |
| Kairos | Face Recognition and Emotion Analysis | `apiKey` | Yes | [Go!](https://www.kairos.com/features) | | Kairos | Face Recognition and Emotion Analysis | `apiKey` | Yes | [Go!](https://www.kairos.com/features) |
| Let's Validate | Uncovers the technologies used on websites and URL to thumbnail | No | Yes | [Go!](https://github.com/letsvalidate/api) | | Let's Validate | Uncovers the technologies used on websites and URL to thumbnail | No | Yes | [Go!](https://github.com/letsvalidate/api) |
| LiveEdu | Live Coding Streaming | `OAuth` | Yes | [Go!](https://www.liveedu.tv/developer/applications/) | | LiveEdu | Live Coding Streaming | `OAuth` | Yes | [Go!](https://www.liveedu.tv/developer/applications/) |
...@@ -234,7 +234,7 @@ API | Description | Auth | HTTPS | Link | ...@@ -234,7 +234,7 @@ API | Description | Auth | HTTPS | Link |
|---|---|---|---|---| |---|---|---|---|---|
| File.io | File Sharing | No | Yes | [Go!](https://www.file.io) | | File.io | File Sharing | No | Yes | [Go!](https://www.file.io) |
| Mercury | Web parser | `apiKey` | Yes | [Go!](https://mercury.postlight.com/web-parser/) | | Mercury | Web parser | `apiKey` | Yes | [Go!](https://mercury.postlight.com/web-parser/) |
| pdflayer API | HTML/URL to PDF | No | Yes | [Go!](https://pdflayer.com) | | pdflayer | HTML/URL to PDF | No | Yes | [Go!](https://pdflayer.com) |
| Pocket | Bookmarking service | `OAuth` | Yes | [Go!](https://getpocket.com/developer/) | | Pocket | Bookmarking service | `OAuth` | Yes | [Go!](https://getpocket.com/developer/) |
| PrexView | Data from XML or JSON to PDF, HTML or Image | `apiKey` | Yes | [Go!](https://prexview.com) | | PrexView | Data from XML or JSON to PDF, HTML or Image | `apiKey` | Yes | [Go!](https://prexview.com) |
| Restpack | Provides screenshot, HTML to PDF, and content extraction APIs | `apiKey` | Yes | [Go!](https://restpack.io/) | | Restpack | Provides screenshot, HTML to PDF, and content extraction APIs | `apiKey` | Yes | [Go!](https://restpack.io/) |
...@@ -424,7 +424,7 @@ API | Description | Auth | HTTPS | Link | ...@@ -424,7 +424,7 @@ API | Description | Auth | HTTPS | Link |
API | Description | Auth | HTTPS | Link | API | Description | Auth | HTTPS | Link |
|---|---|---|---|---| |---|---|---|---|---|
| Newton | Symbolic and Arithmetic Math Calculator | No | Yes | [Go!](https://newton.now.sh/) | | Newton | Symbolic and Arithmetic Math Calculator | No | Yes | [Go!](https://newton.now.sh/) |
| Numbers API | Facts about numbers | No | No | [Go!](http://numbersapi.com) | | Numbers | Facts about numbers | No | No | [Go!](http://numbersapi.com) |
### Music ### Music
API | Description | Auth | HTTPS | Link | API | Description | Auth | HTTPS | Link |
...@@ -455,7 +455,7 @@ API | Description | Auth | HTTPS | Link | ...@@ -455,7 +455,7 @@ API | Description | Auth | HTTPS | Link |
| Chronicling America | Provides access to millions of pages of historic US newspapers from the Library of Congress | No | No | [Go!](http://chroniclingamerica.loc.gov/about/api/) | | Chronicling America | Provides access to millions of pages of historic US newspapers from the Library of Congress | No | No | [Go!](http://chroniclingamerica.loc.gov/about/api/) |
| Feedbin | RSS reader | `OAuth` | Yes | [Go!](https://github.com/feedbin/feedbin-api) | | Feedbin | RSS reader | `OAuth` | Yes | [Go!](https://github.com/feedbin/feedbin-api) |
| New York Times | Provides news | `apiKey` | Yes | [Go!](https://developer.nytimes.com/) | | New York Times | Provides news | `apiKey` | Yes | [Go!](https://developer.nytimes.com/) |
| News API | Headlines currently published on a range of news sources and blogs | `apiKey` | Yes | [Go!](https://newsapi.org/) | | News | Headlines currently published on a range of news sources and blogs | `apiKey` | Yes | [Go!](https://newsapi.org/) |
| NPR One | Personalized news listening experience from NPR | `OAuth` | Yes | [Go!](http://dev.npr.org/api/) | | NPR One | Personalized news listening experience from NPR | `OAuth` | Yes | [Go!](http://dev.npr.org/api/) |
| The Guardian | Access all the content the Guardian creates, categorised by tags and section | `apiKey` | Yes | [Go!](http://open-platform.theguardian.com/) | | The Guardian | Access all the content the Guardian creates, categorised by tags and section | `apiKey` | Yes | [Go!](http://open-platform.theguardian.com/) |
......
...@@ -49,7 +49,7 @@ def check_format(filename): ...@@ -49,7 +49,7 @@ def check_format(filename):
for category, entries in sections.items(): for category, entries in sections.items():
if sorted(entries) != entries: if sorted(entries) != entries:
add_error(section_line_num[category], '{} section is not in alphabetical order'.format(category)) add_error(section_line_num[category], "{} section is not in alphabetical order".format(category))
# END Alphabetical Order # END Alphabetical Order
# START Check Entries # START Check Entries
...@@ -64,6 +64,11 @@ def check_format(filename): ...@@ -64,6 +64,11 @@ def check_format(filename):
add_error(line_num, "each segment must start and end with exactly 1 space") add_error(line_num, "each segment must start and end with exactly 1 space")
# END Global # END Global
segments = [seg.strip() for seg in segments] segments = [seg.strip() for seg in segments]
# START Title
title = segments[index_title].upper()
if title.endswith(' API'):
add_error(line_num, 'Title should not contain "API"')
# END Title
# START Description # START Description
# first character should be capitalized # first character should be capitalized
char = segments[index_desc][0] char = segments[index_desc][0]
...@@ -97,7 +102,7 @@ def check_format(filename): ...@@ -97,7 +102,7 @@ def check_format(filename):
def main(): def main():
num_args = len(sys.argv) num_args = len(sys.argv)
if num_args < 2: if num_args < 2:
print("No .md file passed") print("No file passed (file should contain Markdown table syntax)")
sys.exit(1) sys.exit(1)
check_format(sys.argv[1]) check_format(sys.argv[1])
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment