package for simple interaction with NewsApi and sending html mails

Project description

NewsMe

NewsMe package makes interaction with newsApi easier and allows you to create simple html mails.

Features:

Easy interaction with news api
Simple mail setup! Just provide req information and you are ready to go.
Generate html content from api results in desired form

What do you need to use this app?

If you are going to use NewApi you need an api key
You need an email address to send emails.

How to use?

For interaction with newsApi use News class
For creating html elements use CreateHtml class
For sending mails use Mail class

Installation

git clone https://github.com/lunfman/NewsApp.git

pip install newsme

Modules

News class

News object provides simple interaction with NewsApI.

from news import News
news = News('API_KEY')

Default parameters

default endpoint is everything_endpoint

everything_endpoint = 'https://newsapi.org/v2/everything'
top_headlines_endpoint = 'https://newsapi.org/v2/top-headlines'

# Default endpoint
endpoint = everything_endpoint

# Change endpoint to top_headlines
News.endpoint = News.top_headlines_endpoint

date = today
search_type = qInTitle -> other options is q -> GetNews.search_type = 'q'
default parameters for the api request

params = {
            self.search_type: '',
            'from': self.date,
            'sortBy': 'popularity',
            'language': 'en',
            'apiKey': self.API_KEY,
        }

articles_num = 5 'How many articles you wish to get after extractions works with show and get_list methods

Methods

News.search(keyword)

Method takes one argument -> keyword (what are you searching for?)

Search method interact with the api and save results to api_data and create articles list after execution

from news import News
news = News('API_KEY')
news.search('github')

# get json data after search
data = news.api_data
# data['articles'] etc..

News.get_articles_list()

This method returns a list with articles [article1, article2...] Use this method after search or it will return an empty list

# return a list with articles and sliced by news.article_num value
news.get_articles_list()

News.show()

Method prints to console all articles in formatted form

news.show()
-------------
article source

article title 

article content

article url

News.create_params(**kwargs)

Method for creating parameters. Check Newsapi documentation for parameters).

This method overwrites default parameters
You do not need to provide an api key if you use this method
If you wish to change search_type change it directly do not create it with this method.

news.create_params('date'=date, 'param2':param2)
# Result:
# news.params
{
    'date':date,
    'param2:param2,
    'apiKey':api_key
}

CreateHtml class

Use this class to create an html.

from html_creator import CreateHtml
create_html = CreateHtml()

Methods

CreateHtml.create_html_tags(**kwargs)

This method creates html tags from kwargs. After execution html will be stored in CreateHtml.html.

create_html.create_html_tags(h1='heading 1', p='paragraph 1')
create_html.create_html_tags(h1='heading 2', p='paragraph 2')
html = create_html.html
----------------------------
# html = '<h1>heading 1</h1><p>paragraph 1</p><h1>heading 2</h1><p>paragraph 2</p>'

CreateHtml.read_template()

Use this method if you wish to use your own template. (Works only with very basic templates)
Inside the template should be placed the next string [CONTENT] which will be replaced after with created html.
Templates path by default set to /template.html
The template should have the next name template.html !

/template.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
</head>
<body>
[CONTENT]
</body>
</html>

CreateHtml.replace_templates_content()

Use method to replace templates [CONTENT] string with current CreateHtml.html

# init CreateHtml class
create_html = CreateHtml()
# create a line of html
create_html.create_html_tags(h1='heading 1', p='paragraph 1')
# open template -> template will be stored in create_html.template
create_html.reade_template()
# replace [CONTENT] with created html
create_html.replace_templates_content()

-----------------------------------------
#  create_html.template
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
</head>
<body>
<h1>heading 1</h1><p>paragraph 1</p>
</body>
</html>

CreateHtml.modify_template()

This method combines two previous methods and returns modified template

Mail Class

ShareNews class allows to prepare html file for sending and send mails to desired destination

While init your need to provide the next parameters

mail - mail which is going to connect to smtp server for sending mails
destination - who whill receive message
password - password for the mail
smtp_server - smtp server of provider

Example
smtp.gmail.com
smtp-mail.outlook.com

Default params:

port = '465'

subject = 'News'

from mail import Mail
send = Mail(
        mail='mail which is going to connect to smtp server',
        password = 'password for this mail',
        smtp_server = 'smtp.gmail.com',
        destination = 'mail@mail.com who will receive the message')

How to add html to the ShareNews class?

send.html = 'your html as a string'

The plain text can be added the same way.

Maik.send()

Method for sending an email. Use it when html is added to the class and ready to send an email.

Examples

Examples demonstrate how to use all pieces together to create an app by using this package.

Example 1

Get information from NewsApi and send html mail to your destination.

from html_creator import CreateHtml
from news import News
from mail import Mail

topics = ['github', 'microsoft']

key = 'api_key'
news = News(key)
news.articles_num = 1

create_html = CreateHtml()

sender = Mail(
   mail='mail',
   password='pass',
   destination='to',
   smtp_server='smtp')

for topic in topics:
   create_html.create_html_tags(h1=topic)
   for article in news.search(topic).get_list():
      title = article['title']
      content = article['content']
      create_html.create_html_tags(b=title, p=content)
   

sender.html = create_html.html
sender.text = ''

sender.send()

Example 2

Print news to the console

from news import News

# topics for search
topics = ['github', 'microsoft']

# init GetNews class
news = News('api_key')

# show only two articles
news.articles_num = 2

for topic in topics:
    # search for topic and print news related to the topic
    news.search(topic).show()

Example 3

Use different endpoints and params

from news import News

news = GetNews('apikey')
# using top headlines endpoint
news.endpoint = news.top_headlines_endpoint
news.create_params(
    country = 'us',
)

news.search('').show()

Example 4

Create html mail and send it

from html_creator import CreateHtml
from mail import Mail

sender = Mail(
    mail='mail',
    password= 'pass',
    destination= 'destination',
    smtp_server= 'server',
    subject= 'subject'
)

html_creator = CreateHtml()
heading = 'Heading of the message'
paragraph = 'Some information'

html_creator.create_html_tags(h1=heading, p=paragraph)
# open template and replace [CONTENT] with html
html_creator.modify_template()
# selecting modified template
html = html_creator.template
# adding html to sender
sender.html = html
sender.send()

Project details

Release history Release notifications | RSS feed

This version

0.0.3

Dec 24, 2021

0.0.2

Dec 21, 2021

0.0.1

Dec 18, 2021

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

newsme-0.0.3.tar.gz (10.9 kB view details)

Uploaded Dec 24, 2021 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

newsme-0.0.3-py3-none-any.whl (7.9 kB view details)

Uploaded Dec 24, 2021 Python 3

File details

Details for the file newsme-0.0.3.tar.gz.

File metadata

Download URL: newsme-0.0.3.tar.gz
Upload date: Dec 24, 2021
Size: 10.9 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.7.1 importlib_metadata/3.10.0 pkginfo/1.8.2 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.8

File hashes

Hashes for newsme-0.0.3.tar.gz
Algorithm	Hash digest
SHA256	`e4cdf9bbc89295137c962b421f96eba819cfee5ee106ba8a08ad5dffb9ca94e9`
MD5	`71ce1eb14b5ecae6ef209b485588603f`
BLAKE2b-256	`07f1f6ee55f2737c4bc9ebc6fe1b96359728e6765e281d9680ba5b6640eab1af`

See more details on using hashes here.

File details

Details for the file newsme-0.0.3-py3-none-any.whl.

File metadata

Download URL: newsme-0.0.3-py3-none-any.whl
Upload date: Dec 24, 2021
Size: 7.9 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.7.1 importlib_metadata/3.10.0 pkginfo/1.8.2 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.8

File hashes

Hashes for newsme-0.0.3-py3-none-any.whl
Algorithm	Hash digest
SHA256	`65d3bf2c895a8d9a772241a11195f90aa8d03584830ed1b2aec931e6b439eac9`
MD5	`6c486d8942aea48a4132709ce6ad4f66`
BLAKE2b-256	`d6b177e6379ae3f569fab7b6a6ebd7f9238af6bd0f23f2f319ec97d2c5537472`

See more details on using hashes here.

newsme 0.0.3

Navigation

Verified details

Maintainers

Unverified details

Project links

Meta

Project description

NewsMe

What do you need to use this app?

How to use?

Installation

Modules

News class

Default parameters

Methods

News.search(keyword)

News.get_articles_list()

News.show()

News.create_params(**kwargs)

CreateHtml class

Methods

CreateHtml.create_html_tags(**kwargs)

CreateHtml.read_template()

CreateHtml.replace_templates_content()

CreateHtml.modify_template()

Mail Class

How to add html to the ShareNews class?

Maik.send()

Examples

Example 1

Example 2

Example 3

Example 4

Project details

Verified details

Maintainers

Unverified details

Project links

Meta

Release history Release notifications | RSS feed

Download files

Source Distribution

Built Distribution

File details

File metadata

File hashes

File details

File metadata

File hashes