Im creating the front end for a web service, and another company the back end. I need a good, simple and easily understandable way of making a document of API calls that we can collaborate on and edit together without confusing one another.
are there any good specs/examples etc of project API documentation so this doesnt get in a huge mess with many re-writes?
My choice for documentation: Sphinx.
Others:
epydoc
pylit
But Sphinx is quite awesome.
For small APIs I´ve began to use Google Docs. Its collaboration features are awesome and you can see a list of all changes made on this document.
Related
I needed to implement speech 'identification', ie. Guess if the person who is trying to login, is actually him/her, by matching his/her voice.
To consider the case, where the app doesn't recognize the person, but the user is himself trying to login, then he may bypass it with a pin, setup during initial settings.
I am using Python and Flask, to build the webapp, and included javascript in the question, so as to know of possible ways in it too.
Till now, i read about it from some sources, but i couldn't arrive at a possible solution, on stack overflow, as well as 'few' blog posts.
The best 'possible' solution i could arrive at was Cognitive Speech Services by Microsoft -
https://azure.microsoft.com/en-us/services/cognitive-services/speaker-recognition/
I also thought of recording the voice using the Recorder.js, and analyzing at the server end, but couldn't implement it.
So, i wanted a way to implement it on the web app, even a simple gist with a bit of code on using ms cognitive services (i did read pages of the documentation, but it didnt help much), or doing it by python will be helpful.
The documentation at https://learn.microsoft.com/en-us/azure/cognitive-services/speaker-recognition/home will be helpful. Note that there are clickthrough links to the API reference. It explains the high-level process (use “enrollment” to train).
We have speaker identification, which is distinguishing who is speaking from a group of known voices that you train with. You need to provide labelled data (meaning examples of a known speaker talking): see https://westus.dev.cognitive.microsoft.com/docs/services/563309b6778daf02acc0a508/operations/5645c3271984551c84ec6797.
or
Please follow the below link speech SDK samples.
https://learn.microsoft.com/en-us/azure/cognitive-services/speech-service/
You can use batch transcription api and enable diarization.
https://learn.microsoft.com/en-us/azure/cognitive-services/speech-service/batch-transcription
As #Ram pointed out that we can use the Microsoft Cognitive Services, we used the same to implement it.
First, we needed an API key from Microsoft for the Cognitive Speech Service (they give a 2 keys, and an endpoint for 7 days in a free trial, without any card, and another free version for a year maybe, with card details)
Get the API keys here : https://azure.microsoft.com/en-in/try/cognitive-services/?unauthorized=1
Then, i went through the documentation of Microsoft, but couldn't really be helped by it.
What helped was this : https://github.com/rposbo/speaker-recognition-api
I went through all files, and the 'needed' part was mainly in the speech-recognition-api-demo-core.js and the demo.html
First understand what it's really doing, then only you can implement it on your page.
That actually concludes the answer, since that's how it 'can' be implemented using Javascript.
Extra - https://github.com/AdityaGupta150/ProtoMain - We have used only the needed part of Robin posbo's code (you won't be able to just copy paste, first understand it), and implemented it, you can see that in templates/verification.html
I'm new to the programming world and i'm eager to learn but i've heard that the best way to learn is by having a nice project to work on. And i've always wanted to make a Skill Tracker for my clan. Could you guys give me any advices on what i should learn before being able to start on such a project.
I'm basically looking to make something like: http://runetrack.com/competitions/
I'm familiar with variables, loops, if else statements etc etc. But whenever i try to make a tracker or a simple highscore i get lost because i don't know where to start.
Cheers.
Basically Javascript and html for front end development.
Runescape has a rest API for high scores and the GE (http://services.runescape.com/m=rswiki/en/Grand_Exchange_APIs). You can interact with this API by using AJAX calls.
If you want to host the website, learn how to deploy a simple Apache web server.
Just learn the things I mentioned above: Html, Javascript, AJAX calls (using jQuery) and deploying a simple Apache server. This is more than enough. Along the way you'll pick up other technologies that you might want to use in developing your website.
RuneScape has an api for highscores and the grand exchange. See http://services.runescape.com/m=rswiki/en/Hiscores_APIs . Example of my character: http://services.runescape.com/m=hiscore/index_lite.ws?player=aarony . As for what to output it to, I suggest google apps script to get started.
I created my own google site using the above. If you would like to use it for ideas, you can see it here: https://sites.google.com/site/runescapeaarony/
We are planning to develop a JavaScript API to expose some of our Java EE based services. We are doing this keeping Google Maps API
in mind. Can someone please suggested where we should start and the approaches that we need to follow to create a useful and
extensible JavaScript API? Any suggestion will be greatly helpful for us.
More than google maps, I think you should look at twitter which has a very nice REST API. (https://dev.twitter.com/docs/api) REST is the key of building your API.
Part from that, you should also think about generating API keys, so you have control about who is doing what with your services
Also that seems like a good reading to start:
http://blog.steveklabnik.com/posts/2011-07-03-nobody-understands-rest-or-http
Definitely look to make it a RESTful JSON Api and then you'll be able to use it for various purposes. APIs like twitter et. al. are good models (although there is a lot of back and forth about what is completely REST).
I'm a big fan of Mike Pearce's take on how to design good APIs: http://blog.mikepearce.net/2010/08/08/api-anti-patterns-how-not-to-write-a-restful-api/
I've dived into the GWT world a couple of months ago and find it quite interesting.
I'm currently developing a web application which is to be used internally and so we need to resize the browser window, which can only be done by JSNI. After hitting some problems
regarding the JSNI I was advised to look into jquery and I found that it's counterpart in GWT is GwtQuery. I've tried looking on the project page and googling for tutorials but I can't seem to find a clear beginners tutorial on how to use GwtQuery on GWT but I keep find references to how it's very similar to jquery.
I think it's important to state that I'm not a js developer but rather a java developer who likes the idea of GWT and I just need to use GWTQuery in a very small part of my application.
Thanks in advance for any leads or links.
Ittai
GwtQuery also goes by the name GQuery, so maybe you find more if you search for that.
At Google I/O 2009 the creator of GQuery gave a speech about GQuery, you can find the video and slides here, maybe it helps.
Here you have a presentation I gave about gquery.
The getting started guide in the project site could be useful as well.
The gquery mailing list is a good place to ask questions to developers and users.
Here I found good article with small and simple examples:
GWTQuery – jQuery in GWT
What would be a good mini-project to get intimate with JavaScript, as an advanced 'introduction' to the language? I want to actually code an application in JS, not hook up bits of it to enhance a web application.
A lot of stuff you could learn by doing an RSS reader on a page. Google shows what can be done. The whole lection concentrates on javascript, network access, security restrictions and medium data mangeling.
If you have the ability to do any sort of backend programming than AJAX is really neat to do. You can get a lot of good effects with less efforts. A good thing to build on up.
I would argue that if you're really an advanced programmer then the exercises above would not really give you any insight into the language as they are just variations on things you probably have already done. Javascript's strongest suit is it's LISP style ability to grow. Write something AI(ish) that creates new functions. Most people don't utilize the language in this way, but, its ability to augment its own classes on the fly is, I would argue, it's most unusual and most powerful feature.
Although not a project, watch the Douglas Crockford videos at YUI theater.
The biggest web based Javascript projects are going to deal with the DOM. Do some nifty stuff with JQuery. Make a table with rows that highlight when you hover. Make them update themselves through AJAX and JSON when you click on them.
If you're really looking for something magical and usefull write a scrollable table with fixed headers and footers for IE8.
If you want to stay away from the WEB use the JDK 1.6 and run Javascript code in that. You could do TONS with that.
Whenever I'm trying to get familiar with a language, I will work on Project Euler problems with it.
I would implement a simple game like sokoban first.
The second application would be an AJAX-based multiuser chat application, first fetching other people's responses by polling, later with AJAX push.
Interesting question.
Really you could do any sort of application. In order to make sure you're using the latest and greatest stuff, I'd try making a simple CRUD style application using DHTML and AJAX. Perhaps a contacts list or calendar. If you're feeling really energetic, you could write the back-end in JavaScript as well.
Unless you want to get really friendly with the DOM and browser compatibility, I'd learn Javascript through the mask of one of the nice frameworks like Jquery or Prototype.
The Holy Grail - a WYSIWYG editor. They wouldn't need to complete it, but just seeing their plan of attack would be interesting. Plays right into patterns and OO.
I suggest you create a Google Gadget. You can create one for free and perhaps make something useful out of it. If you don't have a Google account, sign up for one. Then add the Google Gadget Editor to begin writing your code.
With the gadget, you'll be able to mess with JavaScript, JSON, CSS, etc. Furthermore, you'll be able to store the file on Google's server so you can work on it from any computer.
I created a simple RSS reader and wrote JavaScript to get the feed (using Google's API) then dealing with that JavaScript object because it came back as JSON. I then developed some JavaScript to hide/show div tags.
It was a good starter project for me to learn JavaScript.
Get JavaScript the Good Parts by Douglas Crockford. Also check out his web site: http://www.crockford.com
Key reason: just because JavaScript looks like C/C++/Java/C# doesn't mean it actually is like them. Things are significantly different. I suggest reading his book to get a grasp of those differences.
Otherwise, I would look at the JQuery web site. JavaScript is cool and all, but a good framework will save you from a lot of the pitfalls and make you much more productive faster.
try making an advanced AJAX application like for example try to recreate the google calander.
How about a firefox plugin to monitor StackOverflow? It could use RSS to monitor feeds and let you know when new questions are asked with your tags.
It could also be grown as your js skills progress.
Write yet another javascript framework, but focused specially in something, ie game programming.