> [!NOTE] <p><em>ALwrity is All in One Content platform for content writers, without AI tooling knowledge. WIP.
Not just AI Writers, ALwrity is a complete content life cycle platform with **Content planning & Research, Personlized Content Generation, Content SEO audits, Content Scheduling/publishing, Analytics & monitoring & more**. We are busy building blocks for each phase of content life cycle with AI. We'd love your feedback or contributions.</em></p>

# How to ALwrity - Getting Started

ALwrity assists content creators and digital marketers in keyword web research, ![AI writers](https://www.alwrity.com/ai-writing-tools) & ![Social media content generation](https://www.alwrity.com/ai-youtube-script-writer) & ![AI Copywriting](https://www.alwrity.com/ai-copywriting-formula-generator).
Our toolkit integrates **(OpenAI, Gemini, Anthropic)** AI models for text generation, image creation **(Stability.ai), STT(whisper, AssemblyAI)** and AI Web research **(Tavily AI, exa AI, Serper.dev)**, streamlining your content creation pipeline and ensuring high-quality output with minimal effort.

- ![Generate Content Calender for Months](https://www.alwrity.com/post/automating-content-calendars-with-ai-agents)
- ![Specilized AI writers for every need & platform](https://github.com/AJaySi/AI-Writer/wiki/Features-of-ALwrity-AI-writer)
- ![ALwrity AI SEO Tools](https://github.com/AJaySi/AI-Writer/wiki/ALwrity-AI-SEO-Tools)
- ![ALwrity Web Researcher](https://github.com/AJaySi/AI-Writer/wiki/Alwrity-AI-Web-Research-Details-for-content-writing)
- RoadMap - Coming Soon..

---
> ![](https://github.com/AJaySi/AI-Writer/blob/main/lib/workspace/keyword_blog.gif)
---

### Option 1: Get Started Now, [Visit alwrity.com](https://www.alwrity.com/ai-writing-tools) 
> [!NOTE] <p>You will find AI content writing tools, which are Free & No-Signup.
> **Note:** Although, this is limited, as is our wallet & Resources.</p>

### Option 2). **For complete AI content creation toolkit**, alwrity offers a local streamlit UI App.
> [!NOTE] <p>
> Its a BYOK model(Bring Your Own Key).
> **Note:** 🗯️ Now, before you run away 🏃💨   
> If you have 💻 Laptop + 🛜 Internet + 10 minutes, you will be generating blogs, articles etc with just few words.
>
> [Step-By-Step: Getting Started for Absolute Begginers](https://www.alwrity.com/post/getting-started-with-alwrity-ai-writer)
>
>[Getting started for Developers](https://github.com/AJaySi/AI-Writer/wiki/Getting-started-with-ALwrity-AI-writer)
>	<details>
>		<summary>See Details</summary>
>
>	```
>	1). git clone https://github.com/AJaySi/AI-Writer.git
>	2). pip install -r requirements.txt
>	3). streamlit run alwrity.py
>
>	4). Visit Alwrity UI in a Browser & Start generation AI personalized content.
>	```
>	### Updating to latest Code: (Existing users)
>	```
>	1). Git pull
>	2). pip install -U -r requirements.txt
>	3). streamlit run alwrity.py
>	```
>	</details>
> </p>
---
Still stuck, [Open issue here](https://github.com/AJaySi/AI-Writer/issues) & Someone will bail you out.
> ![Alwrity Documentation is here for more details](https://github.com/AJaySi/AI-Writer/wiki)
### ![List of all AI Tools & Features of Alwrity](https://github.com/AJaySi/AI-Writer/wiki/Features-of-ALwrity-AI-writer)
---

> ![AI SEO Tool Structured Data Generator](https://github.com/AJaySi/AI-Writer/blob/main/lib/workspace/structured_data.gif)
---
> ![ALwrity AI Linkedin Post generator](https://github.com/AJaySi/AI-Writer/blob/main/lib/workspace/Alwrity_linkedin_post_generator.gif)
---
> ![AI Google Ads Generator](https://github.com/AJaySi/AI-Writer/blob/main/lib/workspace/alwrity_google_ads_generator.gif)

---

## How To Personlize ALwrity & Content Generation

> ![](https://github.com/AJaySi/AI-Writer/blob/main/lib/workspace/alwrity_ai_writer.png)
![Click to Read Details of each available features](https://github.com/AJaySi/AI-Writer/wiki/ALwrity-Interface-first-page-explanation)

![Read Alwrity Configuration Options](https://www.alwrity.com/post/know-powerful-alwrity-ai-writer-configuration):
> [!NOTE] <p><em>Use ALwrity UI Sidebar to modify Alwrity behavior for your content needs.</em></p>

---

## Alwrity Features: Power Up Your Content Creation Life cycle ⚡️

**AI Writer Tools:**

| Tool                                  | Description                                                                 |
|---------------------------------------|---------------------------------------------------------------------------|
| AI Blog Writer                        | Generates blog content based on the latest web research on given keywords. |
| AI YouTube to Content Writer        | Transforms content from provided YouTube URLs into written form.           |
| AI Long Form Content                  | Creates extensive and detailed articles.                                   |
| AI Essay Writer                       | Produces lengthy essays on various topics, with room for improvement.        |
| AI Story Writer                       | Constructs narratives and stories based on provided backstories and characters. |
| AI Email Writer                        | Generates various types of professional letters.                            |
| AI Letter Writer                       | Crafts business letters for formal communication.                          |
| AI LinkedIn Blog Post Generator     | Develops blog posts optimized for sharing on LinkedIn.                       |
| AI Instagram Caption Generation      | Creates engaging captions for Instagram posts.                              |
| AI Content Outline Generator       | Generates outlines based on keywords gathered from web research.               |

---
**AI SEO Tools:**

| Tool                                  | Description                                                                 |
|---------------------------------------|---------------------------------------------------------------------------|
| AI Content Outline Generator       | Generates outlines based on keywords gathered from web research.               |
| AI SEO - Generate rich snippet from url | Creates structured data for rich snippets (e.g., reviews, recipes) |

**AI Content Planning Tools:**

| Tool                                  | Description                                                                 |
|---------------------------------------|---------------------------------------------------------------------------|
| AI Content Planning & Calendar     | Assists in planning and organizing content with a comprehensive calendar.      |
| Create Blog Images                 | Generates images to complement blog content using Stable Diffusion.            |
| Agentic Content Creation           | Explores innovative content creation methods with CrewAI.                      |
| AI Finance Writer                  | Uses ufinance & padnas_ta to write TA report for given stock symbol            |

**AI Web Research Integrations:**

| Tool                                  | Description                                                                 |
|---------------------------------------|---------------------------------------------------------------------------|
| AI Web Researcher                  | Conducts comprehensive web research and analysis using various methods.        |
| Talk to your Docs (WIP)            | Write content from your local documents of any type (multi-modal)               |

**Integrations:**

| Tool                                  | Description                                                                 |
|---------------------------------------|---------------------------------------------------------------------------|
| AI Agents Team                     | Easily create AI Agents team for Content creation & Digital marketing          |
| Wordpress API integration          | Programmatically upload blogs to wordpress website with API keys               |
| Talk to your website               | Crawl your entire website & write content based on its content, Or Not   |
| Content From URLs                  | Provide any URL to create an original, unique content from                     |

---

## Superpowers 🚀 **🧠  Here's what Alwrity can do for you:**

* **Online content Research:** 🔍  Supercharge your blog posts by integrating insights from online research (SERP, Tavily, Metaphor). Say goodbye to AI hallucinations! Tavily AI, Google Search, SERP, Vision AI, and CrewAI web research agents ensure your content is packed with accurate information.
* **Long Form Content Generation:** ✍️  Write essays, stories, and in-depth blogs with web-researched context. No more staring at a blank page!
* **AI Content Planning & Calendar:** 🗓️  Say goodbye to writer's block! Alwrity will give you months' worth of blog title ideas. 

**🌍  Multi-Language Magic:**

* **Multilingual Support:** 🌎  Write content and conduct web research in your language. We support multiple languages and regions (main_config)!

**🧠  Fighting AI Hallucinations:**

* **Fact-Checked Content:**  🙅  We use web-researched context to generate factual content, eliminating the risk of AI hallucinations. 

**🎨  Multimodal Content Mastery:**

* **Text-To-Text, Speech-To-Text, Text-To-Image, Image-To-Text:** 🖼️  Our multimodal suite empowers you to create a variety of content formats.

**🤖  Your Content Creation Crew:**

* **Agentic Content Team:** 🤝  Build your own AI content team with CrewAI! Define their personas, roles, goals, and tasks. (Beta) 

**📸  Visualize Your Content:**

* **Image Generation and Processing:**  ✨  Create stunning images based on your blog content using DALL-E 3 and Stable Diffusion.  Optimize your images for web use.  (FIXME: More Stable Diffusion magic to come!) 

**SEO Mastery:**

* **SEO Optimization:** 📈  Boost your content's visibility. Alwrity generates SEO-friendly titles, meta descriptions, tags, and categories. 

**🤖  Streamlined Content Publishing:**

* **WordPress & Jekyll Integration:**  🚀  Effortlessly generate and upload your content (and media!) to WordPress using its REST API.  Most markdown-based static websites should integrate seamlessly with minimal effort. 


---
> [!NOTE] <p>This toolkit is designed for automated blog management and requires appropriate API keys and access credentials for full functionality. ALwrity will guide your through this process, we selected APIs which offer generous free trials, **you** only need email id & patience.</p>
---

### Web Research
- **Keyword Research**: Conduct in-depth keyword research by specifying search queries and time ranges.
- **Domain-Specific Searches**: Include specific URLs to confine searches to certain domains, such as Wikipedia or competitor websites.
- **Semantic Analysis**: Explore similar topics and technologies by providing a reference URL for semantic analysis.

### Competitor Analysis
- **Similar Company Discovery**: Analyze competitor websites to discover similar companies, startups, and technologies.
- **Industry Insights**: Gain insights into industry trends, market competitors, and emerging technologies.

### Blog Writing
- **Keyword-Based Blogs**: Generate blog content based on specified keywords, leveraging AI to produce engaging and informative articles.
- **Audio Blog Generation**: Convert audio from YouTube videos into blog posts, facilitating content creation from multimedia sources.
- **GitHub Repository Blogs**: Transform GitHub repositories or topics into blog posts, showcasing code examples and project insights.
- **Scholarly Research Blogs**: Generate blog content based on research papers, summarizing key findings and insights.

### Blogging Tools
- **Title and Meta Description Generation**: Generate catchy titles and meta descriptions for blog posts to improve SEO and user engagement.
- **Blog Outline Creation**: Generate outlines for blog posts, aiding in structuring content and organizing ideas.
- **FAQ Generation**: Automatically generate FAQs (Frequently Asked Questions) based on blog content, enhancing user engagement and SEO.
- **HTML and Markdown Conversion**: Convert blog posts between HTML and Markdown formats for easy integration with various platforms.
- **Blog Proofreading**: Proofread blog content for grammar, spelling, and readability, ensuring high-quality output.
- **Tag and Category Suggestions**: Generate tags and categories for blog posts based on content analysis, improving organization and discoverability.

### Interactive Mode
- **User-Friendly Interface**: Navigate tasks and options easily through an interactive command-line interface.
- **Menu-Driven Interaction**: Choose between various options, tasks, and tools using intuitive menus and prompts.
- **Task Guidance**: Receive guidance and instructions for each task, facilitating user interaction and decision-making.

---

## Standing on Tech-Shoulders of the Giants - (Credits):

- **APIs**:
  - [Exa API](https://exa.ai/): Provides semantic search capabilities for finding similar topics and technologies.
  - [Tavily API](https://tavily.com/): Offers AI-powered web search functionality for conducting in-depth keyword research.
  - [SerperDev API](https://serper.dev/): Enables access to search engine results and competitor analysis data.
  - [YOU.com](https://you.com/): You.com enhances web search, writing, coding, digital art creation, and solving complex problems.
  - [Stability AI](https://stability.ai/): Activating humanity's potential through generative AI. Open models in every modality, for everyone, everywhere.
  - [OpenAI API](https://openai.com/): Powers the Large Language Models (LLMs) for generating blog content and conducting research.
  - [Gemini API](https://gemini.google.com/app): Google powered LLM for natural language processing tasks.
  - [Ollama](https://ollama.com/) : Local, Privacy focused, LLM provider for research and content generation capabilities.
  - [CrewAI](https://www.crewai.com/): Collaborative AI agents framework.
  - [firecrawl](https://www.firecrawl.dev/): Turn websites into LLM-ready data

---

<details><summary><h3>Notes from underground:</h3></summary>
	1). Focus is on writing/generating highly unique, SEO optimized blog content.
	2). Models: Openai, gemini, ollama are interesting. Minstral API is also worth exploring. Cohere API is purpose made.
	Focus is getting the prompts right. Shit in, shit out, irrespective of dollars and cutting edge models.
	Pydantically speakng, Due to experimental nature of prompting, its getting expensive soon enough. Gemini is free for now.
	3). Missing frontend: A smart backend will enable a good frontend. WIP, backend. So, frontend; coming soon.
	4).Getting AI agents to 'brainstrom' blog ideas seems more pressing. CrewAI seems more straightforward than autogen.
	5). Too Many APIs floating around: The implementation is using tools that dont depend on API keys and rather scrape them.
	Duh, scraping wont scale, that is GPT vision based scraping will come in handy.
	6). firecrawl is interesting, gpt-researcher is providing local docsqa.
	7). Had to provide streamlit UI as Alwrity's audience arent comfortable with commandline.
	8). Local folder RAG and Chat with your content, website is on the cards.
	9). AI models are better, not sure until when 'Free' APIs will be "Free".
	10). The code is always a mess, lot of changes happening.. 
	11). Focus is to stop making any more AI content tools, but rather revisit & improve user experience & content quality.
	12). To Err is Human & AI....
	13). ....
</details>

---

#### LICENSE
> [!NOTE]<p><em>
> MIT License
>
> Copyright (c) 2024 Alwrity
> 
> Permission is hereby granted, free of charge, to any person obtaining a copy
> of this software and associated documentation files (the "Software"), to deal
> in the Software without restriction, including without limitation the rights
> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
> copies of the Software, and to permit persons to whom the Software is
> furnished to do so, subject to the following conditions:
>
> The above copyright notice and this permission notice shall be included in all
> copies or substantial portions of the Software.
> 
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
> SOFTWARE.
> </em></p>

